contain the basic data for the Darcy solver. More...

#include <DarcyData.hpp>

Collaboration diagram for DarcyData< MeshType >:

Private Attributes
dataPtr_Type	M_data
	Inhibited assign operator. More...

std::string	M_section
	Section in GetPot file. More...

timeDataPtr_Type	M_time
	Data container for time. More...

timeAdvanceDataPtr_Type	M_timeAdvance
	Data container for time advance. More...

meshDataPtr_Type	M_mesh
	Data container for mesh. More...

paramListPtr_Type	M_linearAlgebraList
	Teuchos paramter list for linear algebra. More...

std::string	M_linearSolverSection
	Section in the parameter list for linear solver. More...

std::string	M_precondSection
	Section in the parameter list for preconditioner. More...

UInt	M_verbose
	Output verbose. More...

Public Types
typedef MeshType	mesh_Type
	Typedef for the mesh template. More...

typedef GetPot	data_Type
	Typedef for the GetPot data. More...

typedef std::shared_ptr< data_Type >	dataPtr_Type
	Shared pointer for the data. More...

typedef Teuchos::ParameterList	paramList_Type
	Teuchos parameter list. More...

typedef Teuchos::RCP< paramList_Type >	paramListPtr_Type
	Shared pointer for the Teuchos parameter list. More...

typedef TimeData	timeData_Type
	Typedef for the time data. More...

typedef std::shared_ptr< timeData_Type >	timeDataPtr_Type
	Shared pointer for the time data. More...

typedef TimeAdvanceData	timeAdvanceData_Type
	Typedef for the time advance data. More...

typedef std::shared_ptr< timeAdvanceData_Type >	timeAdvanceDataPtr_Type
	Shared pointer for the time advance data. More...

typedef MeshData	meshData_Type
	Typedef for the mesh data. More...

typedef std::shared_ptr< meshData_Type >	meshDataPtr_Type
	Shared pointer for the mesh data. More...

typedef DarcyData< mesh_Type >	darcyData_Type
	Self typedef. More...

Constructors
	DarcyData ()
	Empty Constructor. More...

	DarcyData (const data_Type &dataFile, const std::string &section="darcy")
	Constructor using a data file. More...

Methods
void	setup (const data_Type &dataFile, const std::string &section="darcy")
	External set-up. More...

Set methods
void	setLinearAlgebraList (const paramListPtr_Type &linearAlgebraList, const std::string &linearSolver="Linear Solver", const std::string &precond="Preconditioner")
	Set Teuchos parameter list for linear algebra. More...

void	setTimeData (const timeDataPtr_Type &timeData)
	Set data time container. More...

void	setMeshData (const meshDataPtr_Type &meshData)
	Set mesh container. More...

Get methods
UInt	verbose () const
	Get the level of verbosity of the problem. More...

std::string	section () const
	Get the main section of the data file. More...

const dataPtr_Type &	dataFilePtr () const
	Get the data file of the problem. More...

dataPtr_Type &	dataFilePtr ()
	Get the data file of the problem. More...

const timeDataPtr_Type &	dataTimePtr () const
	Get data time container. More...

timeDataPtr_Type &	dataTimePtr ()
	Get data time container. More...

const timeAdvanceDataPtr_Type &	dataTimeAdvancePtr () const
	Get data time advance container. More...

timeAdvanceDataPtr_Type &	dataTimeAdvancePtr ()
	Get data time advance container. More...

const meshDataPtr_Type &	meshDataPtr () const
	Get mesh container. More...

meshDataPtr_Type &	meshDataPtr ()
	Get mesh container. More...

const paramList_Type &	linearSolverList () const
	Get Teuchos parameter list for the linear solver. More...

const paramList_Type &	preconditionerList () const
	Get Teuchos parameter list for the preconditioner. More...

Private Constructors
	DarcyData (const darcyData_Type &)
	Inhibited copy constructor. More...

Private Operators
darcyData_Type &	operator= (const darcyData_Type &)
	Inhibited assign operator. More...

Detailed Description

template<typename MeshType>
class LifeV::DarcyData< MeshType >

contain the basic data for the Darcy solver.

In particular it stores the data as GetPot object, the data for the mesh and the data for the time schemes.

Definition at line 61 of file DarcyData.hpp.

Member Typedef Documentation

◆ mesh_Type

typedef MeshType mesh_Type

Typedef for the mesh template.

Definition at line 70 of file DarcyData.hpp.

◆ data_Type

typedef GetPot data_Type

Typedef for the GetPot data.

Definition at line 73 of file DarcyData.hpp.

◆ dataPtr_Type

typedef std::shared_ptr< data_Type > dataPtr_Type

Shared pointer for the data.

Definition at line 76 of file DarcyData.hpp.

◆ paramList_Type

typedef Teuchos::ParameterList paramList_Type

Teuchos parameter list.

Definition at line 79 of file DarcyData.hpp.

◆ paramListPtr_Type

typedef Teuchos::RCP< paramList_Type > paramListPtr_Type

Shared pointer for the Teuchos parameter list.

Definition at line 82 of file DarcyData.hpp.

◆ timeData_Type

typedef TimeData timeData_Type

Typedef for the time data.

Definition at line 85 of file DarcyData.hpp.

◆ timeDataPtr_Type

typedef std::shared_ptr< timeData_Type > timeDataPtr_Type

Shared pointer for the time data.

Definition at line 88 of file DarcyData.hpp.

◆ timeAdvanceData_Type

typedef TimeAdvanceData timeAdvanceData_Type

Typedef for the time advance data.

Definition at line 91 of file DarcyData.hpp.

◆ timeAdvanceDataPtr_Type

typedef std::shared_ptr< timeAdvanceData_Type > timeAdvanceDataPtr_Type

Shared pointer for the time advance data.

Definition at line 94 of file DarcyData.hpp.

◆ meshData_Type

typedef MeshData meshData_Type

Typedef for the mesh data.

Definition at line 97 of file DarcyData.hpp.

◆ meshDataPtr_Type

typedef std::shared_ptr< meshData_Type > meshDataPtr_Type

Shared pointer for the mesh data.

Definition at line 100 of file DarcyData.hpp.

◆ darcyData_Type

typedef DarcyData< mesh_Type > darcyData_Type

Self typedef.

Definition at line 103 of file DarcyData.hpp.

Constructor & Destructor Documentation

◆ DarcyData() [1/3]

DarcyData ( )

inline

Empty Constructor.

Definition at line 112 of file DarcyData.hpp.

◆ DarcyData() [2/3]

DarcyData	(	const data_Type &	dataFile,
		const std::string &	section = `"darcy"`
	)

Constructor using a data file.

Parameters

dataFile	GetPot data file for set-up the problem.
section	the section for the Darcy data.

◆ DarcyData() [3/3]

DarcyData ( const darcyData_Type & )

private

Inhibited copy constructor.

Member Function Documentation

◆ setup()

void setup	(	const data_Type &	dataFile,
		const std::string &	section = `"darcy"`
	)

External set-up.

Parameters

dataFile	The data file with all the data.
section	The global section.

Definition at line 342 of file DarcyData.hpp.

◆ setLinearAlgebraList()

void setLinearAlgebraList	(	const paramListPtr_Type &	linearAlgebraList,
		const std::string &	linearSolver = `"Linear Solver"`,
		const std::string &	precond = `"Preconditioner"`
	)

inline

Set Teuchos parameter list for linear algebra.

Parameters

paramList	Teuchos RCP with the parameter list.
linearSolver	Section of the linear solver in the paramList.
precond	Section of the preconditioner in the paramList.

Definition at line 148 of file DarcyData.hpp.

◆ setTimeData()

void setTimeData ( const timeDataPtr_Type & timeData )

inline

Set data time container.

Parameters

timeData Boost shared_ptr to timeData container

Definition at line 161 of file DarcyData.hpp.

◆ setMeshData()

void setMeshData ( const meshDataPtr_Type & meshData )

inline

Set mesh container.

Parameters

meshData Boost shared_ptr to meshData container

Definition at line 170 of file DarcyData.hpp.

◆ verbose()

UInt verbose ( ) const

inline

Get the level of verbosity of the problem.

Definition at line 180 of file DarcyData.hpp.

◆ section()

std::string section ( ) const

inline

Get the main section of the data file.

Definition at line 186 of file DarcyData.hpp.

◆ dataFilePtr() [1/2]

const dataPtr_Type& dataFilePtr ( ) const

inline

Get the data file of the problem.

Returns: shared_ptr to data container.

Definition at line 195 of file DarcyData.hpp.

◆ dataFilePtr() [2/2]

dataPtr_Type& dataFilePtr ( )

inline

Get the data file of the problem.

Returns: shared_ptr to data container.

Definition at line 204 of file DarcyData.hpp.

◆ dataTimePtr() [1/2]

const timeDataPtr_Type& dataTimePtr ( ) const

inline

Get data time container.

Returns: shared_ptr to TimeData container.

Definition at line 213 of file DarcyData.hpp.

◆ dataTimePtr() [2/2]

timeDataPtr_Type& dataTimePtr ( )

inline

Get data time container.

Returns: shared_ptr to TimeData container.

Definition at line 222 of file DarcyData.hpp.

◆ dataTimeAdvancePtr() [1/2]

const timeAdvanceDataPtr_Type& dataTimeAdvancePtr ( ) const

inline

Get data time advance container.

Returns: shared_ptr to TimeAdvanceData container.

Definition at line 231 of file DarcyData.hpp.

◆ dataTimeAdvancePtr() [2/2]

timeAdvanceDataPtr_Type& dataTimeAdvancePtr ( )

inline

Get data time advance container.

Returns: shared_ptr to TimeAdvanceData container.

Definition at line 240 of file DarcyData.hpp.

◆ meshDataPtr() [1/2]

const meshDataPtr_Type& meshDataPtr ( ) const

inline

Get mesh container.

Returns: shared_ptr to meshData container.

Definition at line 249 of file DarcyData.hpp.

◆ meshDataPtr() [2/2]

meshDataPtr_Type& meshDataPtr ( )

inline

Get mesh container.

Returns: shared_ptr to meshData container.

Definition at line 258 of file DarcyData.hpp.

◆ linearSolverList()

const paramList_Type& linearSolverList ( ) const

inline

Get Teuchos parameter list for the linear solver.

Returns: Teuchos RCP with the parameter list for the linear solver.

Definition at line 267 of file DarcyData.hpp.

◆ preconditionerList()

const paramList_Type& preconditionerList ( ) const

inline

Get Teuchos parameter list for the preconditioner.

Returns: Teuchos RCP with the parameter list for the preconditioner.

Definition at line 277 of file DarcyData.hpp.

◆ operator=()

darcyData_Type& operator= ( const darcyData_Type & )

private

Inhibited assign operator.

Field Documentation

◆ M_data

dataPtr_Type M_data

private

Inhibited assign operator.

Data GetPot.

Definition at line 306 of file DarcyData.hpp.

◆ M_section

std::string M_section

private

Section in GetPot file.

Definition at line 309 of file DarcyData.hpp.

◆ M_time

timeDataPtr_Type M_time

private

Data container for time.

Definition at line 312 of file DarcyData.hpp.

◆ M_timeAdvance

timeAdvanceDataPtr_Type M_timeAdvance

private

Data container for time advance.

Definition at line 315 of file DarcyData.hpp.

◆ M_mesh

meshDataPtr_Type M_mesh

private

Data container for mesh.

Definition at line 318 of file DarcyData.hpp.

◆ M_linearAlgebraList

paramListPtr_Type M_linearAlgebraList

private

Teuchos paramter list for linear algebra.

Definition at line 321 of file DarcyData.hpp.

◆ M_linearSolverSection

std::string M_linearSolverSection

private

Section in the parameter list for linear solver.

Definition at line 324 of file DarcyData.hpp.

◆ M_precondSection

std::string M_precondSection

private

Section in the parameter list for preconditioner.

Definition at line 327 of file DarcyData.hpp.

◆ M_verbose

UInt M_verbose

private

Output verbose.

Definition at line 330 of file DarcyData.hpp.

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

DarcyData.hpp

Private Attributes

Public Types

Constructors

Methods

Set methods

Get methods

Private Constructors

Private Operators

Detailed Description

template<typename MeshType> class LifeV::DarcyData< MeshType >

Member Typedef Documentation

◆ mesh_Type

◆ data_Type

◆ dataPtr_Type

◆ paramList_Type

◆ paramListPtr_Type

◆ timeData_Type

◆ timeDataPtr_Type

◆ timeAdvanceData_Type

◆ timeAdvanceDataPtr_Type

◆ meshData_Type

◆ meshDataPtr_Type

◆ darcyData_Type

Constructor & Destructor Documentation

◆ DarcyData() [1/3]

◆ DarcyData() [2/3]

◆ DarcyData() [3/3]

Member Function Documentation

◆ setup()

◆ setLinearAlgebraList()

◆ setTimeData()

◆ setMeshData()

◆ verbose()

◆ section()

◆ dataFilePtr() [1/2]

◆ dataFilePtr() [2/2]

◆ dataTimePtr() [1/2]

◆ dataTimePtr() [2/2]

◆ dataTimeAdvancePtr() [1/2]

◆ dataTimeAdvancePtr() [2/2]

◆ meshDataPtr() [1/2]

◆ meshDataPtr() [2/2]

◆ linearSolverList()

◆ preconditionerList()

◆ operator=()

Field Documentation

◆ M_data

◆ M_section

◆ M_time

◆ M_timeAdvance

◆ M_mesh

◆ M_linearAlgebraList

◆ M_linearSolverSection

◆ M_precondSection

◆ M_verbose

template<typename MeshType>
class LifeV::DarcyData< MeshType >