MultiscaleAlgorithmExplicit - The Multiscale Algorithm implementation of Explicit. More...

#include <MultiscaleAlgorithmExplicit.hpp>

Inheritance diagram for MultiscaleAlgorithmExplicit:

Collaboration diagram for MultiscaleAlgorithmExplicit:

Constructors & Destructor
	MultiscaleAlgorithmExplicit ()
	Constructor. More...

virtual	~MultiscaleAlgorithmExplicit ()
	Destructor. More...

Multiscale Algorithm Virtual Methods
void	setupData (const std::string &fileName)
	Setup the data of the algorithm using a data file. More...

void	subIterate ()
	Perform sub-iteration on the coupling variables. More...

Unimplemented Methods
	MultiscaleAlgorithmExplicit (const MultiscaleAlgorithmExplicit &algorithm)

MultiscaleAlgorithmExplicit &	operator= (const MultiscaleAlgorithmExplicit &algorithm)

Additional Inherited Members
Public Types inherited from MultiscaleAlgorithm
typedef MultiscaleModelMultiscale	multiscaleModelMultiscale_Type

typedef multiscaleModelMultiscale_Type *	multiscaleModelMultiscalePtr_Type

Public Member Functions inherited from MultiscaleAlgorithm
	MultiscaleAlgorithm ()
	Constructor. More...

virtual	~MultiscaleAlgorithm ()
	Destructor. More...

virtual void	setupAlgorithm ()
	Setup coupling variables and other quantities of the algorithm. More...

virtual void	showMe ()
	Display some information about the algorithm. More...

Real	computeResidual () const

void	setCommunicator (const multiscaleCommPtr_Type &comm)
	Set the epetra communicator for the model. More...

void	setMultiscaleModel (const multiscaleModelMultiscalePtr_Type model)
	Set the main Multiscale model. More...

void	setSubiterationsMaximumNumber (const UInt &subiterationsMaximumNumber)
	Set the maximum number of subiterations. More...

void	setTolerance (const Real &tolerance)
	Set the tolerance. More...

void	setAlgorithmName (const multiscaleParameterList_Type &parameterList)
	Set the algorithm name. More...

virtual void	setAlgorithmParameters (const multiscaleParameterList_Type &parameterList)
	Set the the main parameters of the algorithm (tolerance, maximum number of subiterations, etc.) More...

const algorithms_Type &	type () const
	Get the type of the algorithm. More...

const multiscaleModelMultiscalePtr_Type &	multiScaleProblem () const
	Get the Multiscale problem. More...

const multiscaleVectorPtr_Type &	couplingVariables () const
	Get the coupling variables. More...

const multiscaleVectorPtr_Type &	couplingResiduals () const
	Get the coupling residuals. More...

const multiscaleCommPtr_Type &	communicator () const
	Get the communicator. More...

const UInt &	subiterationsMaximumNumber () const
	Get the subiterations maximum number. More...

const Real &	tolerance () const
	Get the required tolerance. More...

Protected Member Functions inherited from MultiscaleAlgorithm
void	save (const UInt &subiterationsNumber, const Real &residual) const
	save on a Matlab file the information about the convergence of the algorithm. More...

bool	checkResidual (const UInt &subIT=0) const
	Update the residual and check if the tolerance has been satisfied. More...

Protected Attributes inherited from MultiscaleAlgorithm
algorithms_Type	M_type

std::string	M_name

multiscaleModelMultiscalePtr_Type	M_multiscale

multiscaleVectorPtr_Type	M_couplingVariables

multiscaleVectorPtr_Type	M_couplingResiduals

multiscaleCommPtr_Type	M_comm

UInt	M_subiterationsMaximumNumber

Real	M_tolerance

Detailed Description

MultiscaleAlgorithmExplicit - The Multiscale Algorithm implementation of Explicit.

Author: Cristiano Malossi

See also: Full description of the Geometrical Multiscale Framework: [15]; Methodology: [12] [13] [14] [2]; Applications: [11] [10] [3]

The MultiscaleAlgorithmExplicit is an implementation of multiscaleAlgorithm_Type which implements the Explicit method.

Definition at line 58 of file MultiscaleAlgorithmExplicit.hpp.

Constructor & Destructor Documentation

◆ MultiscaleAlgorithmExplicit() [1/2]

MultiscaleAlgorithmExplicit ( )

explicit

Constructor.

Definition at line 47 of file MultiscaleAlgorithmExplicit.cpp.

◆ ~MultiscaleAlgorithmExplicit()

virtual ~MultiscaleAlgorithmExplicit ( )

inlinevirtual

Destructor.

Definition at line 69 of file MultiscaleAlgorithmExplicit.hpp.

◆ MultiscaleAlgorithmExplicit() [2/2]

MultiscaleAlgorithmExplicit ( const MultiscaleAlgorithmExplicit & algorithm )

private

Member Function Documentation

◆ setupData()

void setupData ( const std::string & fileName )

virtual

Setup the data of the algorithm using a data file.

Parameters

fileName Name of the data file.

Implements MultiscaleAlgorithm.

Definition at line 62 of file MultiscaleAlgorithmExplicit.cpp.

◆ subIterate()

void subIterate ( )

virtual

Perform sub-iteration on the coupling variables.

Reimplemented from MultiscaleAlgorithm.

Definition at line 78 of file MultiscaleAlgorithmExplicit.cpp.

◆ operator=()

MultiscaleAlgorithmExplicit& operator= ( const MultiscaleAlgorithmExplicit & algorithm )

private

The documentation for this class was generated from the following files:

Constructors & Destructor

Multiscale Algorithm Virtual Methods

Unimplemented Methods

Additional Inherited Members