MultiscaleModel0D - Multiscale model for 0D simulations. More...

#include <MultiscaleModel0D.hpp>

Inheritance diagram for MultiscaleModel0D:

Collaboration diagram for MultiscaleModel0D:

Private Attributes
dataPtr_Type	M_data

solverPtr_Type	M_solver

bcInterfacePtr_Type	M_bc

Type definitions
typedef ZeroDimensionalData	data_Type

typedef std::shared_ptr< data_Type >	dataPtr_Type

typedef ZeroDimensionalSolver	solver_Type

typedef std::shared_ptr< solver_Type >	solverPtr_Type

typedef ZeroDimensionalBCHandler	bc_Type

typedef std::shared_ptr< bc_Type >	bcPtr_Type

typedef BCInterface0D< bc_Type, data_Type >	bcInterface_Type

typedef std::shared_ptr< bcInterface_Type >	bcInterfacePtr_Type

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

virtual	~MultiscaleModel0D ()
	Destructor. More...

MultiscaleModel Methods
void	setupData (const std::string &fileName)
	Setup the data of the model. More...

void	setupModel ()
	Setup the model. More...

void	buildModel ()
	Build the initial model. More...

void	updateModel ()
	Update the model. More...

void	solveModel ()
	Solve the model. More...

void	updateSolution ()
	Update the solution. More...

void	saveSolution ()
	Save the solution. More...

void	showMe ()
	Display some information about the model. More...

Real	checkSolution () const
	Return a specific scalar quantity to be used for a comparison with a reference value. More...

Get Methods
bcInterface_Type &	bcInterface ()
	Get the BCInterface container of the boundary conditions of the model. More...

data_Type &	data () const
	Get the data container of the model. More...

solver_Type &	solver () const
	Get the solver of the model. More...

Private Methods
void	setupGlobalData (const std::string &fileName)
	Setup the global data of the model. More...

Additional Inherited Members
Public Member Functions inherited from MultiscaleModel
	MultiscaleModel ()
	The main constructor. More...

virtual	~MultiscaleModel ()
	Destructor. More...

void	clearCouplingsList ()
	Clear the list of pointers to the couplings. More...

void	setID (const UInt &id)
	Set the global ID of the model. More...

void	setCouplingsNumber (const UInt &couplingsNumber)
	Set the number of couplings attached to this model. More...

void	setCoupling (const UInt &localCouplingID, const multiscaleCouplingPtr_Type &coupling)
	Add a pointer to one of the couplings attached to this model. More...

void	addCoupling (const multiscaleCouplingPtr_Type &coupling)
	Add a pointer to one of the couplings which couple the model. More...

void	setGlobalData (const multiscaleDataPtr_Type &globalData)
	Setup the global data of the model. More...

void	setGeometry (const std::array< Real, NDIM > &scale, const std::array< Real, NDIM > &rotate, const std::array< Real, NDIM > &translate)
	Scale, rotate and translate the Model in the 3D space. More...

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

const UInt &	ID () const
	Get the global ID of the model. More...

const models_Type &	type () const
	Get the type of the model. More...

const multiscaleID_Type &	boundaryFlag (const multiscaleID_Type &boundaryID) const
	Get one available flag by id. More...

const std::string &	modelName () const
	Get the name of the model. More...

UInt	couplingsNumber () const
	Get the number of couplings connecting the model. More...

UInt	couplingLocalID (const UInt &ID) const
	Get the coupling local ID through global ID. More...

multiscaleCouplingPtr_Type	coupling (const UInt &localID) const
	Get the coupling through local ID. More...

const multiscaleDataPtr_Type &	globalData () const
	Get the global data of the model. More...

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

Protected Member Functions inherited from MultiscaleModel
void	displayModelStatus (const std::string &tag) const
	Display model ID and name with a user provided tag. More...

Protected Attributes inherited from MultiscaleModel
UInt	M_ID

models_Type	M_type

multiscaleCouplingsContainer_Type	M_couplings

std::string	M_modelName

multiscaleIDContainer_Type	M_boundaryFlags

multiscaleDataPtr_Type	M_globalData

std::array< Real, NDIM >	M_geometryScale

std::array< Real, NDIM >	M_geometryRotate

std::array< Real, NDIM >	M_geometryTranslate

multiscaleCommPtr_Type	M_comm

Detailed Description

MultiscaleModel0D - Multiscale model for 0D simulations.

Author: Mahmoud Jafargholi

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

The MultiscaleModel0D class is an implementation of the multiscaleModel_Type for 0D problems.

Definition at line 65 of file MultiscaleModel0D.hpp.

Member Typedef Documentation

◆ data_Type

typedef ZeroDimensionalData data_Type

Definition at line 72 of file MultiscaleModel0D.hpp.

◆ dataPtr_Type

typedef std::shared_ptr< data_Type > dataPtr_Type

Definition at line 73 of file MultiscaleModel0D.hpp.

◆ solver_Type

typedef ZeroDimensionalSolver solver_Type

Definition at line 74 of file MultiscaleModel0D.hpp.

◆ solverPtr_Type

typedef std::shared_ptr< solver_Type > solverPtr_Type

Definition at line 75 of file MultiscaleModel0D.hpp.

◆ bc_Type

typedef ZeroDimensionalBCHandler bc_Type

Definition at line 77 of file MultiscaleModel0D.hpp.

◆ bcPtr_Type

typedef std::shared_ptr< bc_Type > bcPtr_Type

Definition at line 78 of file MultiscaleModel0D.hpp.

◆ bcInterface_Type

typedef BCInterface0D< bc_Type, data_Type > bcInterface_Type

Definition at line 79 of file MultiscaleModel0D.hpp.

◆ bcInterfacePtr_Type

typedef std::shared_ptr< bcInterface_Type > bcInterfacePtr_Type

Definition at line 80 of file MultiscaleModel0D.hpp.

Constructor & Destructor Documentation

◆ MultiscaleModel0D()

MultiscaleModel0D ( )

explicit

Constructor.

Definition at line 49 of file MultiscaleModel0D.cpp.

Here is the caller graph for this function:

◆ ~MultiscaleModel0D()

virtual ~MultiscaleModel0D ( )

inlinevirtual

Destructor.

Definition at line 92 of file MultiscaleModel0D.hpp.

Member Function Documentation

◆ setupData()

void setupData ( const std::string & fileName )

virtual

Setup the data of the model.

Parameters

fileName Name of data file.

Reimplemented from MultiscaleModel.

Definition at line 66 of file MultiscaleModel0D.cpp.

◆ setupModel()

void setupModel ( )

virtual

Setup the model.

Implements MultiscaleModel.

Definition at line 93 of file MultiscaleModel0D.cpp.

◆ buildModel()

void buildModel ( )

virtual

Build the initial model.

Implements MultiscaleModel.

Definition at line 104 of file MultiscaleModel0D.cpp.

◆ updateModel()

void updateModel ( )

virtual

Update the model.

Implements MultiscaleModel.

Definition at line 114 of file MultiscaleModel0D.cpp.

◆ solveModel()

void solveModel ( )

virtual

Solve the model.

Implements MultiscaleModel.

Definition at line 124 of file MultiscaleModel0D.cpp.

◆ updateSolution()

void updateSolution ( )

virtual

Update the solution.

Implements MultiscaleModel.

Definition at line 139 of file MultiscaleModel0D.cpp.

◆ saveSolution()

void saveSolution ( )

virtual

Save the solution.

Implements MultiscaleModel.

Definition at line 149 of file MultiscaleModel0D.cpp.

◆ showMe()

void showMe ( )

virtual

Display some information about the model.

Reimplemented from MultiscaleModel.

Definition at line 160 of file MultiscaleModel0D.cpp.

◆ checkSolution()

Real checkSolution ( ) const

virtual

Return a specific scalar quantity to be used for a comparison with a reference value.

This method is meant to be used for night checks.

Returns: reference quantity.

Implements MultiscaleModel.

Definition at line 171 of file MultiscaleModel0D.cpp.

◆ bcInterface()

bcInterface_Type& bcInterface ( )

inline

Get the BCInterface container of the boundary conditions of the model.

Returns: BCInterface container

Definition at line 152 of file MultiscaleModel0D.hpp.

◆ data()

data_Type& data ( ) const

inline

Get the data container of the model.

Returns: data container

Definition at line 161 of file MultiscaleModel0D.hpp.

◆ solver()

solver_Type& solver ( ) const

inline

Get the solver of the model.

Returns: solver

Definition at line 170 of file MultiscaleModel0D.hpp.

◆ setupGlobalData()

void setupGlobalData ( const std::string & fileName )

private

Setup the global data of the model.

In particular, it replaces the default local values with the ones in the global container. If a value is already specified in the data file, do not perform the replacement.

Parameters

fileName File name of the specific model.

Definition at line 182 of file MultiscaleModel0D.cpp.

Here is the caller graph for this function:

Field Documentation

◆ M_data

dataPtr_Type M_data

private

Definition at line 194 of file MultiscaleModel0D.hpp.

◆ M_solver

solverPtr_Type M_solver

private

Definition at line 195 of file MultiscaleModel0D.hpp.

◆ M_bc

bcInterfacePtr_Type M_bc

private

Definition at line 196 of file MultiscaleModel0D.hpp.

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

Private Attributes

Type definitions

Constructors & Destructor

MultiscaleModel Methods

Get Methods

Private Methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ data_Type

◆ dataPtr_Type

◆ solver_Type

◆ solverPtr_Type

◆ bc_Type

◆ bcPtr_Type

◆ bcInterface_Type

◆ bcInterfacePtr_Type

Constructor & Destructor Documentation

◆ MultiscaleModel0D()

◆ ~MultiscaleModel0D()

Member Function Documentation

◆ setupData()

◆ setupModel()

◆ buildModel()

◆ updateModel()

◆ solveModel()

◆ updateSolution()

◆ saveSolution()

◆ showMe()

◆ checkSolution()

◆ bcInterface()

◆ data()

◆ solver()

◆ setupGlobalData()

Field Documentation

◆ M_data

◆ M_solver

◆ M_bc