#include <HyperbolicData.hpp>

Collaboration diagram for HyperbolicData< Mesh >:

Protected Attributes
DataPtr_Type	M_data
	Data containers for time and mesh. More...

TimePtr_Type	M_time

MeshPtr_Type	M_mesh

UInt	M_verbose
	Miscellaneous. More...

std::string	M_section

Real	M_relaxCFL
	Relax parameter for the CFL condition. More...

Public Types
typedef GetPot	Data_Type

typedef std::shared_ptr< Data_Type >	DataPtr_Type

typedef TimeData	Time_Type

typedef std::shared_ptr< Time_Type >	TimePtr_Type

typedef MeshData	Mesh_Type

typedef std::shared_ptr< Mesh_Type >	MeshPtr_Type

Constructor & Destructor
	HyperbolicData ()
	Empty Constructor. More...

	HyperbolicData (const GetPot &dataFile, const std::string &section="hyperbolic")
	Constructor using a data file. More...

	HyperbolicData (const HyperbolicData &hyperbolicData)
	Copy constructor. More...

virtual	~HyperbolicData ()
	Virtual destructor. More...

Operators
HyperbolicData &	operator= (const HyperbolicData &hyperbolicData)
	Assign operator overloading. More...

Methods
void	setup (const Data_Type &dataFile, const std::string &section="hyperbolic")
	External setup. More...

void	showMe (std::ostream &output=std::cout) const
	Print attributes of the class. More...

Set Methods
void	setTimeData (const TimePtr_Type TimeData)
	Set data time container. More...

void	setMeshData (const MeshPtr_Type MeshData)
	Set mesh container. More...

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

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

DataPtr_Type	dataFile () const
	Get the data file of the problem. More...

TimePtr_Type	dataTime () const
	Get data time container. More...

MeshPtr_Type	meshData () const
	Get mesh container. More...

Real	getCFLRelaxParameter () const
	Get the relaxation parameter for the CFL condition. More...

Detailed Description

template<typename Mesh>
class LifeV::HyperbolicData< Mesh >

Author: Alessio Fumagalli aless.nosp@m.io.f.nosp@m.umaga.nosp@m.lli@.nosp@m.mail..nosp@m.poli.nosp@m.mi.it; Michel Kern miche.nosp@m.l.ke.nosp@m.rn@in.nosp@m.ria..nosp@m.fr

This class contain the basic data for the hyperbolic solver. In particoular it stores

the GetPot data file;
the time class handler;
the mesh class handler;
the level of verbosity of the solver hyperbolic;
the section for the GetPot data file;
the relax parameter for the CFL condition.

Todo:: class not finished!

Definition at line 64 of file HyperbolicData.hpp.

Member Typedef Documentation

◆ Data_Type

typedef GetPot Data_Type

Definition at line 71 of file HyperbolicData.hpp.

◆ DataPtr_Type

typedef std::shared_ptr< Data_Type > DataPtr_Type

Definition at line 72 of file HyperbolicData.hpp.

◆ Time_Type

typedef TimeData Time_Type

Definition at line 74 of file HyperbolicData.hpp.

◆ TimePtr_Type

typedef std::shared_ptr< Time_Type > TimePtr_Type

Definition at line 75 of file HyperbolicData.hpp.

◆ Mesh_Type

typedef MeshData Mesh_Type

Definition at line 77 of file HyperbolicData.hpp.

◆ MeshPtr_Type

typedef std::shared_ptr< Mesh_Type > MeshPtr_Type

Definition at line 78 of file HyperbolicData.hpp.

Constructor & Destructor Documentation

◆ HyperbolicData() [1/3]

HyperbolicData ( )

Empty Constructor.

Definition at line 227 of file HyperbolicData.hpp.

Here is the caller graph for this function:

◆ HyperbolicData() [2/3]

HyperbolicData	(	const GetPot &	dataFile,
		const std::string &	section = `"hyperbolic"`
	)

Constructor using a data file.

Parameters

dataFile	GetPot data file for setup the problem
section	the section for the Hyperbolic data

◆ HyperbolicData() [3/3]

HyperbolicData ( const HyperbolicData< Mesh > & hyperbolicData )

Copy constructor.

Parameters

hyperbolicData object to take a copy

Definition at line 243 of file HyperbolicData.hpp.

Here is the caller graph for this function:

◆ ~HyperbolicData()

~HyperbolicData ( )

virtual

Virtual destructor.

Definition at line 259 of file HyperbolicData.hpp.

Member Function Documentation

◆ operator=()

HyperbolicData< Mesh > & operator= ( const HyperbolicData< Mesh > & hyperbolicData )

Assign operator overloading.

Parameters

hyperbolicData The hyperbolicData to be copied

Definition at line 271 of file HyperbolicData.hpp.

◆ setup()

void setup	(	const Data_Type &	dataFile,
		const std::string &	section = `"hyperbolic"`
	)

External setup.

Parameters

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

Definition at line 297 of file HyperbolicData.hpp.

◆ showMe()

void showMe ( std::ostream & output = std::cout ) const

Print attributes of the class.

Parameters

output Stream to put the output

Definition at line 332 of file HyperbolicData.hpp.

◆ setTimeData()

void setTimeData ( const TimePtr_Type TimeData )

inline

Set data time container.

Parameters

TimeData Boost shared_ptr to TimeData container

Definition at line 142 of file HyperbolicData.hpp.

◆ setMeshData()

void setMeshData ( const MeshPtr_Type MeshData )

inline

Set mesh container.

Parameters

MeshData Boost shared_ptr to meshData container

Definition at line 151 of file HyperbolicData.hpp.

◆ verbose()

UInt verbose ( ) const

inline

Get the level of verbosity of the problem.

Definition at line 160 of file HyperbolicData.hpp.

◆ section()

const std::string section ( ) const

inline

Get the main section of the data file.

Definition at line 166 of file HyperbolicData.hpp.

◆ dataFile()

DataPtr_Type dataFile ( ) const

inline

Get the data file of the problem.

Definition at line 172 of file HyperbolicData.hpp.

◆ dataTime()

TimePtr_Type dataTime ( ) const

inline

Get data time container.

Returns: shared_ptr to TimeData container

Definition at line 181 of file HyperbolicData.hpp.

◆ meshData()

MeshPtr_Type meshData ( ) const

inline

Get mesh container.

Returns: shared_ptr to meshData container

Definition at line 190 of file HyperbolicData.hpp.

◆ getCFLRelaxParameter()

Real getCFLRelaxParameter ( ) const

inline

Get the relaxation parameter for the CFL condition.

Definition at line 199 of file HyperbolicData.hpp.

Field Documentation

◆ M_data

DataPtr_Type M_data

protected

Data containers for time and mesh.

Definition at line 209 of file HyperbolicData.hpp.

◆ M_time

TimePtr_Type M_time

protected

Definition at line 210 of file HyperbolicData.hpp.

◆ M_mesh

MeshPtr_Type M_mesh

protected

Definition at line 211 of file HyperbolicData.hpp.

◆ M_verbose

UInt M_verbose

protected

Miscellaneous.

Definition at line 214 of file HyperbolicData.hpp.

◆ M_section

std::string M_section

protected

Definition at line 215 of file HyperbolicData.hpp.

◆ M_relaxCFL

Real M_relaxCFL

protected

Relax parameter for the CFL condition.

Definition at line 218 of file HyperbolicData.hpp.

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

HyperbolicData.hpp

Protected Attributes

Public Types

Constructor & Destructor

Operators

Methods

Set Methods

Get Methods

Detailed Description

template<typename Mesh> class LifeV::HyperbolicData< Mesh >

Member Typedef Documentation

◆ Data_Type

◆ DataPtr_Type

◆ Time_Type

◆ TimePtr_Type

◆ Mesh_Type

◆ MeshPtr_Type

Constructor & Destructor Documentation

◆ HyperbolicData() [1/3]

◆ HyperbolicData() [2/3]

◆ HyperbolicData() [3/3]

◆ ~HyperbolicData()

Member Function Documentation

◆ operator=()

◆ setup()

◆ showMe()

◆ setTimeData()

◆ setMeshData()

◆ verbose()

◆ section()

◆ dataFile()

◆ dataTime()

◆ meshData()

◆ getCFLRelaxParameter()

Field Documentation

◆ M_data

◆ M_time

◆ M_mesh

◆ M_verbose

◆ M_section

◆ M_relaxCFL

template<typename Mesh>
class LifeV::HyperbolicData< Mesh >