LifeV::Multiscale Namespace Reference

Data Structures
class	FSI3DBoundaryAreaFunction
	FSI3DBoundaryAreaFunction - The FSI3D area function. More...
class	FSI3DBoundaryFlowRateFunction
	FSI3DBoundaryFlowRateFunction - The FSI3D coupling function. More...
class	FSI3DBoundaryStressFunction
	FSI3DBoundaryStressFunction - The FSI3D coupling function. More...
class	MultiscaleAlgorithm
	MultiscaleAlgorithm - The Multiscale Algorithm Interface. More...
class	MultiscaleAlgorithmAitken
	MultiscaleAlgorithmAitken - The Multiscale Algorithm implementation of Aitken. More...
class	MultiscaleAlgorithmBroyden
	MultiscaleAlgorithmBroyden - The Multiscale Algorithm implementation of Broyden. More...
class	MultiscaleAlgorithmExplicit
	MultiscaleAlgorithmExplicit - The Multiscale Algorithm implementation of Explicit. More...
class	MultiscaleAlgorithmNewton
	MultiscaleAlgorithmNewton - The Multiscale Algorithm implementation of Newton. More...
class	MultiscaleCommunicatorsManager
	MultiscaleCommunicatorsManager - The Multiscale Communicators Manager. More...
class	MultiscaleCoupling
	MultiscaleCoupling - The Multiscale Physical Coupling. More...
class	MultiscaleCouplingBoundaryCondition
	MultiscaleCouplingBoundaryCondition - Coupling condition for standard boundary conditions. More...
class	MultiscaleCouplingFunction
	MultiscaleCouplingFunction - The multiscale function for the couplings. More...
class	MultiscaleCouplingMeanNormalStress
	MultiscaleCouplingMeanNormalStress - Stress coupling condition. More...
class	MultiscaleCouplingMeanNormalStressArea
	MultiscaleCouplingMeanNormalStressArea - Mean normal stress with area coupling condition. More...
class	MultiscaleCouplingMeanNormalStressValve
	MultiscaleCouplingMeanNormalStressValve - Mean normal stress coupling condition with simple valve. More...
class	MultiscaleCouplingMeanTotalNormalStress
	MultiscaleCouplingMeanTotalNormalStress - Stress coupling condition. More...
class	MultiscaleCouplingMeanTotalNormalStressArea
	MultiscaleCouplingMeanTotalNormalStressArea - Mean normal stress with area coupling condition. More...
class	MultiscaleGlobalData
	MultiscaleGlobalData - Global data container for the physical quantities of the problem. More...
class	MultiscaleInterface
	MultiscaleInterface - The multiscale interface for fluid problems. More...
class	MultiscaleModel
	MultiscaleModel - The Multiscale Physical Model. More...
class	MultiscaleModel0D
	MultiscaleModel0D - Multiscale model for 0D simulations. More...
class	MultiscaleModelFluid3D
	MultiscaleModelFluid3D - Multiscale model for 3D Fluid simulations. More...
class	MultiscaleModelFSI1D
	MultiscaleModelFSI1D - Multiscale model for 1D Fluid simulations. More...
class	MultiscaleModelFSI3D
	MultiscaleModelFSI3D - Multiscale model for 3D FSI simulations. More...
class	MultiscaleModelMultiscale
	MultiscaleModelMultiscale - Multiscale model. More...
class	MultiscaleModelWindkessel0D
	MultiscaleModelWindkessel0D - Multiscale model for Windkessel 0D terminals. More...
class	MultiscaleSolver
	MultiscaleSolver - The Multiscale solver. More...

Typedefs
typedef flag_Type	multiscaleID_Type
typedef std::vector< multiscaleID_Type >	multiscaleIDContainer_Type
typedef multiscaleIDContainer_Type::const_iterator	multiscaleIDContainerConstIterator_Type
typedef Displayer::commPtr_Type	multiscaleCommPtr_Type
typedef VectorEpetra	multiscaleVector_Type
typedef std::shared_ptr< multiscaleVector_Type >	multiscaleVectorPtr_Type
typedef MatrixEpetra< Real >	multiscaleMatrix_Type
typedef std::shared_ptr< multiscaleMatrix_Type >	multiscaleMatrixPtr_Type
typedef LinearSolver::parameterList_Type	multiscaleParameterList_Type
typedef LinearSolver::parameterListPtr_Type	multiscaleParameterListPtr_Type
typedef MultiscaleAlgorithm	multiscaleAlgorithm_Type
typedef std::shared_ptr< multiscaleAlgorithm_Type >	multiscaleAlgorithmPtr_Type
typedef FactorySingleton< Factory< multiscaleAlgorithm_Type, algorithms_Type > >	multiscaleAlgorithmFactory_Type
typedef MultiscaleModel	multiscaleModel_Type
typedef std::shared_ptr< multiscaleModel_Type >	multiscaleModelPtr_Type
typedef FactorySingleton< Factory< multiscaleModel_Type, models_Type > >	multiscaleModelFactory_Type
typedef MultiscaleCoupling	multiscaleCoupling_Type
typedef std::shared_ptr< multiscaleCoupling_Type >	multiscaleCouplingPtr_Type
typedef FactorySingleton< Factory< multiscaleCoupling_Type, couplings_Type > >	multiscaleCouplingFactory_Type
typedef std::vector< multiscaleModelPtr_Type >	multiscaleModelsContainer_Type
typedef multiscaleModelsContainer_Type::iterator	multiscaleModelsContainerIterator_Type
typedef multiscaleModelsContainer_Type::const_iterator	multiscaleModelsContainerConstIterator_Type
typedef std::vector< multiscaleCouplingPtr_Type >	multiscaleCouplingsContainer_Type
typedef multiscaleCouplingsContainer_Type::iterator	multiscaleCouplingsContainerIterator_Type
typedef multiscaleCouplingsContainer_Type::const_iterator	multiscaleCouplingsContainerConstIterator_Type
typedef MultiscaleGlobalData	multiscaleData_Type
typedef std::shared_ptr< multiscaleData_Type >	multiscaleDataPtr_Type

Enumerations
enum	algorithms_Type { Aitken, Broyden, Explicit, Newton }
enum	models_Type {   Fluid3D, FSI1D, FSI3D, Multiscale,   Windkessel0D, ZeroDimensional }
enum	couplings_Type {   BoundaryCondition, MeanNormalStress, MeanNormalStressArea, MeanNormalStressValve,   MeanTotalNormalStress, MeanTotalNormalStressArea }
enum	errors_Type {   IterationsMaximumNumber, Tolerance, Residual, Solution,   ModelType, CouplingType, ModelInterface }

Functions
multiscaleAlgorithm_Type *	createMultiscaleAlgorithmAitken ()
	Factory create function. More...
multiscaleAlgorithm_Type *	createMultiscaleAlgorithmBroyden ()
	Factory create function. More...
multiscaleAlgorithm_Type *	createMultiscaleAlgorithmExplicit ()
	Factory create function. More...
multiscaleAlgorithm_Type *	createMultiscaleAlgorithmNewton ()
	Factory create function. More...
multiscaleCoupling_Type *	createMultiscaleCouplingBoundaryCondition ()
	Factory create function. More...
multiscaleCoupling_Type *	createMultiscaleCouplingMeanNormalStress ()
	Factory create function. More...
multiscaleCoupling_Type *	createMultiscaleCouplingMeanNormalStressArea ()
	Factory create function. More...
multiscaleCoupling_Type *	createMultiscaleCouplingMeanNormalStressValve ()
	Factory create function. More...
multiscaleCoupling_Type *	createMultiscaleCouplingMeanTotalNormalStress ()
	Factory create function. More...
multiscaleCoupling_Type *	createMultiscaleCouplingMeanTotalNormalStressArea ()
	Factory create function. More...
multiscaleModel_Type *	createMultiscaleModelZeroDimensional ()
	Factory create function. More...
multiscaleModel_Type *	createMultiscaleModelFluid3D ()
	Factory create function. More...
multiscaleModel_Type *	createMultiscaleModelFSI1D ()
	Factory create function. More...
multiscaleModel_Type *	createMultiscaleModelFSI3D ()
	Factory create function. More...
multiscaleModel_Type *	createMultiscaleModelMultiscale ()
	Factory create function. More...
void	multiscaleMapsDefinition ()
	Define the map of the MS objects. More...
template<typename DerivedType , typename BasePtrType >
std::shared_ptr< DerivedType >	multiscaleDynamicCast (BasePtrType &base)
	Perform a dynamic cast from a base class to a derived class. More...
void	multiscaleErrorMessage (const std::stringstream &errorMessage)
	Display and error message. More...
void	multiscaleErrorCheck (const errors_Type &error, const std::string &message="", const UInt &isLeader=true)
	Create an error message. More...
multiscaleModel_Type *	createMultiscaleModelWindkessel0D ()
	Factory create function. More...

Variables
std::map< std::string, algorithms_Type >	multiscaleAlgorithmsMap
std::map< std::string, couplings_Type >	multiscaleCouplingsMap
UInt	multiscaleCoresPerNode = 1
std::string	multiscaleProblemFolder = "./"
std::string	multiscaleProblemPrefix = "Multiscale"
UInt	multiscaleProblemStep = 0
UInt	multiscaleSaveEachNTimeSteps = 1
bool	multiscaleExitFlag = EXIT_SUCCESS
std::map< std::string, models_Type >	multiscaleModelsMap

Typedef Documentation

multiscaleID_Type

typedef flag_Type multiscaleID_Type

Definition at line 145 of file MultiscaleDefinitions.hpp.

multiscaleIDContainer_Type

typedef std::vector< multiscaleID_Type > multiscaleIDContainer_Type

Definition at line 149 of file MultiscaleDefinitions.hpp.

multiscaleIDContainerConstIterator_Type

typedef multiscaleIDContainer_Type::const_iterator multiscaleIDContainerConstIterator_Type

Definition at line 150 of file MultiscaleDefinitions.hpp.

multiscaleCommPtr_Type

typedef Displayer::commPtr_Type multiscaleCommPtr_Type

Definition at line 152 of file MultiscaleDefinitions.hpp.

multiscaleVector_Type

typedef VectorEpetra multiscaleVector_Type

Definition at line 154 of file MultiscaleDefinitions.hpp.

multiscaleVectorPtr_Type

typedef std::shared_ptr< multiscaleVector_Type > multiscaleVectorPtr_Type

Definition at line 155 of file MultiscaleDefinitions.hpp.

multiscaleMatrix_Type

typedef MatrixEpetra< Real > multiscaleMatrix_Type

Definition at line 157 of file MultiscaleDefinitions.hpp.

multiscaleMatrixPtr_Type

typedef std::shared_ptr< multiscaleMatrix_Type > multiscaleMatrixPtr_Type

Definition at line 158 of file MultiscaleDefinitions.hpp.

multiscaleParameterList_Type

typedef LinearSolver::parameterList_Type multiscaleParameterList_Type

Definition at line 160 of file MultiscaleDefinitions.hpp.

multiscaleParameterListPtr_Type

typedef LinearSolver::parameterListPtr_Type multiscaleParameterListPtr_Type

Definition at line 161 of file MultiscaleDefinitions.hpp.

multiscaleAlgorithm_Type

typedef MultiscaleAlgorithm multiscaleAlgorithm_Type

Definition at line 163 of file MultiscaleDefinitions.hpp.

multiscaleAlgorithmPtr_Type

typedef std::shared_ptr< multiscaleAlgorithm_Type > multiscaleAlgorithmPtr_Type

Definition at line 164 of file MultiscaleDefinitions.hpp.

multiscaleAlgorithmFactory_Type

typedef FactorySingleton< Factory< multiscaleAlgorithm_Type, algorithms_Type > > multiscaleAlgorithmFactory_Type

Definition at line 165 of file MultiscaleDefinitions.hpp.

multiscaleModel_Type

typedef MultiscaleModel multiscaleModel_Type

Definition at line 167 of file MultiscaleDefinitions.hpp.

multiscaleModelPtr_Type

typedef std::shared_ptr< multiscaleModel_Type > multiscaleModelPtr_Type

Definition at line 168 of file MultiscaleDefinitions.hpp.

multiscaleModelFactory_Type

typedef FactorySingleton< Factory< multiscaleModel_Type, models_Type > > multiscaleModelFactory_Type

Definition at line 169 of file MultiscaleDefinitions.hpp.

multiscaleCoupling_Type

typedef MultiscaleCoupling multiscaleCoupling_Type

Definition at line 171 of file MultiscaleDefinitions.hpp.

multiscaleCouplingPtr_Type

typedef std::shared_ptr< multiscaleCoupling_Type > multiscaleCouplingPtr_Type

Definition at line 172 of file MultiscaleDefinitions.hpp.

multiscaleCouplingFactory_Type

typedef FactorySingleton< Factory< multiscaleCoupling_Type, couplings_Type > > multiscaleCouplingFactory_Type

Definition at line 173 of file MultiscaleDefinitions.hpp.

multiscaleModelsContainer_Type

typedef std::vector< multiscaleModelPtr_Type > multiscaleModelsContainer_Type

Definition at line 175 of file MultiscaleDefinitions.hpp.

multiscaleModelsContainerIterator_Type

typedef multiscaleModelsContainer_Type::iterator multiscaleModelsContainerIterator_Type

Definition at line 176 of file MultiscaleDefinitions.hpp.

multiscaleModelsContainerConstIterator_Type

typedef multiscaleModelsContainer_Type::const_iterator multiscaleModelsContainerConstIterator_Type

Definition at line 177 of file MultiscaleDefinitions.hpp.

multiscaleCouplingsContainer_Type

typedef std::vector< multiscaleCouplingPtr_Type > multiscaleCouplingsContainer_Type

Definition at line 179 of file MultiscaleDefinitions.hpp.

multiscaleCouplingsContainerIterator_Type

typedef multiscaleCouplingsContainer_Type::iterator multiscaleCouplingsContainerIterator_Type

Definition at line 180 of file MultiscaleDefinitions.hpp.

multiscaleCouplingsContainerConstIterator_Type

typedef multiscaleCouplingsContainer_Type::const_iterator multiscaleCouplingsContainerConstIterator_Type

Definition at line 181 of file MultiscaleDefinitions.hpp.

multiscaleData_Type

typedef MultiscaleGlobalData multiscaleData_Type

Definition at line 183 of file MultiscaleDefinitions.hpp.

multiscaleDataPtr_Type

typedef std::shared_ptr< multiscaleData_Type > multiscaleDataPtr_Type

Definition at line 184 of file MultiscaleDefinitions.hpp.

Enumeration Type Documentation

algorithms_Type

enum algorithms_Type

Enumerator
Aitken	Aitken method
Broyden	Broyden method (start from exact Jacobian Matrix)
Explicit	Explicit method
Newton	Newton method (with exact Jacobian Matrix)

Definition at line 76 of file MultiscaleDefinitions.hpp.

models_Type

enum models_Type

Enumerator
Fluid3D	Fluid (Oseen) 3D model
FSI1D	1D model
FSI3D	FSI 3D model
Multiscale	Multiscale model
Windkessel0D	Windkessel0D model
ZeroDimensional	0D model

Definition at line 86 of file MultiscaleDefinitions.hpp.

couplings_Type

enum couplings_Type

Enumerator
BoundaryCondition	Boundary condition
MeanNormalStress	Mean normal stress coupling condition
MeanNormalStressArea	Mean normal stress with area coupling condition
MeanNormalStressValve	Mean normal stress coupling condition with simple valve
MeanTotalNormalStress	Mean total normal stress coupling condition
MeanTotalNormalStressArea	Mean total normal stress with area coupling condition

Definition at line 98 of file MultiscaleDefinitions.hpp.

errors_Type

enum errors_Type

Enumerator
IterationsMaximumNumber	Maximum number of iterations reached
Tolerance	Tolerance not satisfied
Residual	External residual not satisfied
Solution	Solution check not satisfied
ModelType	Model type not recognized
CouplingType	Coupling type not recognized
ModelInterface	Model interface not available

Definition at line 108 of file MultiscaleDefinitions.hpp.

Function Documentation

createMultiscaleAlgorithmAitken()

multiscaleAlgorithm_Type* LifeV::Multiscale::createMultiscaleAlgorithmAitken ( )

inline

Factory create function.

Definition at line 127 of file MultiscaleAlgorithmAitken.hpp.

createMultiscaleAlgorithmBroyden()

multiscaleAlgorithm_Type* LifeV::Multiscale::createMultiscaleAlgorithmBroyden ( )

inline

Factory create function.

Definition at line 165 of file MultiscaleAlgorithmBroyden.hpp.

createMultiscaleAlgorithmExplicit()

multiscaleAlgorithm_Type* LifeV::Multiscale::createMultiscaleAlgorithmExplicit ( )

inline

Factory create function.

Definition at line 102 of file MultiscaleAlgorithmExplicit.hpp.

createMultiscaleAlgorithmNewton()

multiscaleAlgorithm_Type* LifeV::Multiscale::createMultiscaleAlgorithmNewton ( )

inline

Factory create function.

Definition at line 114 of file MultiscaleAlgorithmNewton.hpp.

createMultiscaleCouplingBoundaryCondition()

multiscaleCoupling_Type* LifeV::Multiscale::createMultiscaleCouplingBoundaryCondition ( )

inline

Factory create function.

Definition at line 199 of file MultiscaleCouplingBoundaryCondition.hpp.

createMultiscaleCouplingMeanNormalStress()

multiscaleCoupling_Type* LifeV::Multiscale::createMultiscaleCouplingMeanNormalStress ( )

inline

Factory create function.

Definition at line 156 of file MultiscaleCouplingMeanNormalStress.hpp.

createMultiscaleCouplingMeanNormalStressArea()

multiscaleCoupling_Type* LifeV::Multiscale::createMultiscaleCouplingMeanNormalStressArea ( )

inline

Factory create function.

Definition at line 142 of file MultiscaleCouplingMeanNormalStressArea.hpp.

createMultiscaleCouplingMeanNormalStressValve()

multiscaleCoupling_Type* LifeV::Multiscale::createMultiscaleCouplingMeanNormalStressValve ( )

inline

Factory create function.

Definition at line 152 of file MultiscaleCouplingMeanNormalStressValve.hpp.

createMultiscaleCouplingMeanTotalNormalStress()

multiscaleCoupling_Type* LifeV::Multiscale::createMultiscaleCouplingMeanTotalNormalStress ( )

inline

Factory create function.

Definition at line 156 of file MultiscaleCouplingMeanTotalNormalStress.hpp.

createMultiscaleCouplingMeanTotalNormalStressArea()

multiscaleCoupling_Type* LifeV::Multiscale::createMultiscaleCouplingMeanTotalNormalStressArea ( )

inline

Factory create function.

Definition at line 142 of file MultiscaleCouplingMeanTotalNormalStressArea.hpp.

createMultiscaleModelZeroDimensional()

multiscaleModel_Type* LifeV::Multiscale::createMultiscaleModelZeroDimensional ( )

inline

Factory create function.

Definition at line 200 of file MultiscaleModel0D.hpp.

createMultiscaleModelFluid3D()

multiscaleModel_Type* LifeV::Multiscale::createMultiscaleModelFluid3D ( )

inline

Factory create function.

Definition at line 483 of file MultiscaleModelFluid3D.hpp.

createMultiscaleModelFSI1D()

multiscaleModel_Type* LifeV::Multiscale::createMultiscaleModelFSI1D ( )

inline

Factory create function.

Definition at line 582 of file MultiscaleModelFSI1D.hpp.

createMultiscaleModelFSI3D()

multiscaleModel_Type* LifeV::Multiscale::createMultiscaleModelFSI3D ( )

inline

Factory create function.

Definition at line 1221 of file MultiscaleModelFSI3D.hpp.

createMultiscaleModelMultiscale()

multiscaleModel_Type* LifeV::Multiscale::createMultiscaleModelMultiscale ( )

inline

Factory create function.

Definition at line 209 of file MultiscaleModelMultiscale.hpp.

multiscaleMapsDefinition()

void LifeV::Multiscale::multiscaleMapsDefinition ( )

inline

Define the map of the MS objects.

Definition at line 192 of file MultiscaleDefinitions.hpp.

Here is the caller graph for this function:

multiscaleDynamicCast()

std::shared_ptr< DerivedType > LifeV::Multiscale::multiscaleDynamicCast ( BasePtrType &  base )

inline

Perform a dynamic cast from a base class to a derived class.

Parameters

base	- pointer to the base object

Returns

pointer to the derived object

Definition at line 231 of file MultiscaleDefinitions.hpp.

multiscaleErrorMessage()

void LifeV::Multiscale::multiscaleErrorMessage ( const std::stringstream &  errorMessage )

inline

Display and error message.

Parameters

errorMessage

- The message that should be displayed

Definition at line 241 of file MultiscaleDefinitions.hpp.

Here is the caller graph for this function:

multiscaleErrorCheck()

void LifeV::Multiscale::multiscaleErrorCheck ( const errors_Type &  error, const std::string &  message = "", const UInt &  isLeader = true  )

inline

Create an error message.

Parameters

error	- The error type
message	- Additional information about the error

Definition at line 252 of file MultiscaleDefinitions.hpp.

createMultiscaleModelWindkessel0D()

multiscaleModel_Type* LifeV::Multiscale::createMultiscaleModelWindkessel0D ( )

inline

Factory create function.

Definition at line 378 of file MultiscaleModelWindkessel0D.hpp.

Variable Documentation

multiscaleAlgorithmsMap

std::map< std::string, algorithms_Type > multiscaleAlgorithmsMap

Definition at line 44 of file MultiscaleAlgorithm.cpp.

multiscaleCouplingsMap

std::map< std::string, couplings_Type > multiscaleCouplingsMap

Definition at line 44 of file MultiscaleCoupling.cpp.

multiscaleCoresPerNode

UInt multiscaleCoresPerNode = 1

Definition at line 44 of file MultiscaleSolver.cpp.

multiscaleProblemFolder

std::string multiscaleProblemFolder = "./"

Definition at line 45 of file MultiscaleSolver.cpp.

multiscaleProblemPrefix

std::string multiscaleProblemPrefix = "Multiscale"

Definition at line 46 of file MultiscaleSolver.cpp.

multiscaleProblemStep

UInt multiscaleProblemStep = 0

Definition at line 47 of file MultiscaleSolver.cpp.

multiscaleSaveEachNTimeSteps

UInt multiscaleSaveEachNTimeSteps = 1

Definition at line 48 of file MultiscaleSolver.cpp.

multiscaleExitFlag

bool multiscaleExitFlag = EXIT_SUCCESS

Definition at line 49 of file MultiscaleSolver.cpp.

multiscaleModelsMap

std::map< std::string, models_Type > multiscaleModelsMap

Definition at line 44 of file MultiscaleModel.cpp.