TimeAdvanceData Class Reference

TimeAdvanceData - Class for handling temporal discretization. More...

#include <TimeAdvanceData.hpp>

Collaboration diagram for TimeAdvanceData:

Private Attributes
UInt	M_orderBDF
Real	M_theta
Real	M_gamma

Constructors & Destructor
	TimeAdvanceData ()
	Empty Constructor. More...
	TimeAdvanceData (const GetPot &dataFile, const std::string &section="time_discretization")
	Constructor. More...
	TimeAdvanceData (const TimeAdvanceData &TimeAdvanceData)
	Copy constructor. More...
virtual	~TimeAdvanceData ()
	Virtual destructor. More...

Methods
void	setup (const GetPot &dfile, const std::string &section="time_discretization")
	Read the dataFile and set all the internal quantities. More...
void	showMe (std::ostream &output=std::cout) const
	Display general information about the content of the class. More...

Set Methods
void	setOrderBDF (const UInt &orderBDF)
	Set the BDF odert to use. More...
void	setTheta (const Real &theta)
	Set the theta of TimeAdvanceNewmark scheme. More...
void	setGamma (const Real &gamma)
	Set the theta of TimeAdvanceNewmark scheme. More...

Get Methods
const UInt &	orderBDF () const
	Get the BDF order used. More...
const Real &	theta () const
	Return theta parameter of TimeAdvanceNewmark scheme. More...
const Real &	gamma () const
	Return gamma of TimeAdvanceNewmark scheme. More...
std::vector< Real >	coefficientsNewmark ()
	Return TimeAdvanceNewmark parameters ( , ) More...

Detailed Description

TimeAdvanceData - Class for handling temporal discretization.

Author

Cristiano Malossi

The class is a data container for the time discretization.

Definition at line 55 of file TimeAdvanceData.hpp.

Constructor & Destructor Documentation

TimeAdvanceData() [1/3]

TimeAdvanceData

(

)

Empty Constructor.

Definition at line 45 of file TimeAdvanceData.cpp.

TimeAdvanceData() [2/3]

TimeAdvanceData	(	const GetPot &	dataFile,
		const std::string &	section = "time_discretization"
	)

Constructor.

Parameters

dataFile	GetPot data file
section	the section on the data file that contains the information on the time discretization

Definition at line 52 of file TimeAdvanceData.cpp.

TimeAdvanceData() [3/3]

TimeAdvanceData

(

const TimeAdvanceData &

TimeAdvanceData

)

Copy constructor.

Parameters

TimeAdvanceData

- TimeAdvanceData class

Definition at line 57 of file TimeAdvanceData.cpp.

~TimeAdvanceData()

virtual ~TimeAdvanceData ( )

inlinevirtual

Virtual destructor.

Definition at line 79 of file TimeAdvanceData.hpp.

Member Function Documentation

setup()

void setup	(	const GetPot &	dfile,
		const std::string &	section = "time_discretization"
	)

Read the dataFile and set all the internal quantities.

Parameters

dataFile	data file
section	section of the file

Definition at line 68 of file TimeAdvanceData.cpp.

Here is the caller graph for this function:

showMe()

void showMe

(

std::ostream &

output = std::cout

)

const

Display general information about the content of the class.

Parameters

output

- specify the output format (std::cout by default)

Definition at line 76 of file TimeAdvanceData.cpp.

setOrderBDF()

void setOrderBDF ( const UInt &  orderBDF )

inline

Set the BDF odert to use.

Parameters

order

BDF order

Definition at line 110 of file TimeAdvanceData.hpp.

setTheta()

void setTheta ( const Real &  theta )

inline

Set the theta of TimeAdvanceNewmark scheme.

Parameters

theta

- coefficient of TimeAdvanceNewmark scheme

Definition at line 119 of file TimeAdvanceData.hpp.

setGamma()

void setGamma ( const Real &  gamma )

inline

Set the theta of TimeAdvanceNewmark scheme.

Parameters

gamma-

coefficient of TimeAdvanceNewmark scheme

Definition at line 128 of file TimeAdvanceData.hpp.

orderBDF()

const UInt& orderBDF ( ) const

inline

Get the BDF order used.

Returns

BDF order value

Definition at line 143 of file TimeAdvanceData.hpp.

theta()

const Real& theta ( ) const

inline

Return theta parameter of TimeAdvanceNewmark scheme.

Returns

theta value

Definition at line 152 of file TimeAdvanceData.hpp.

gamma()

const Real& gamma ( ) const

inline

Return gamma of TimeAdvanceNewmark scheme.

Returns

gamma value

Definition at line 161 of file TimeAdvanceData.hpp.

coefficientsNewmark()

std::vector< Real > coefficientsNewmark

(

)

Return TimeAdvanceNewmark parameters ( , )

Returns

TimeAdvanceNewmark parameters ( , )

Definition at line 90 of file TimeAdvanceData.cpp.

Field Documentation

M_orderBDF

UInt M_orderBDF

private

Definition at line 176 of file TimeAdvanceData.hpp.

M_theta

Real M_theta

private

Definition at line 177 of file TimeAdvanceData.hpp.

M_gamma

Real M_gamma

private

Definition at line 178 of file TimeAdvanceData.hpp.

---

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

• TimeAdvanceData.hpp
• TimeAdvanceData.cpp