ZeroDimensionalBC Class Reference

ZeroDimensionalBC - A boundary condition for zero-dimensional models. More...

#include <ZeroDimensionalBC.hpp>

Collaboration diagram for ZeroDimensionalBC:

Private Attributes
bcType_Type	M_bcType
bcFunction_Type	M_bcFunction

Type definitions
typedef ZeroDimensionalFunction	bcFunction_Type
typedef ZeroDimensionalBCType	bcType_Type

Constructors & Destructor
	ZeroDimensionalBC ()
	Constructor. More...
	ZeroDimensionalBC (const ZeroDimensionalBC &bc)
virtual	~ZeroDimensionalBC ()
	Destructor. More...

Methods
Real	evaluate (const Real &time) const
	Evaluate the bc. More...

Set Methods
void	setBC (const bcType_Type &bcType, const bcFunction_Type &bcFunction)
	Set the function. More...
void	setBCFunction (const bcFunction_Type &function)
	Set the function. More...
void	setBcType (const bcType_Type &bcType)
	Set the type. More...

Get Methods
const bcType_Type &	bcType () const
	Get the type. More...
const bcFunction_Type &	bcFunction () const
	Get the bc function. More...

Detailed Description

ZeroDimensionalBC - A boundary condition for zero-dimensional models.

Author

Cristiano Malossi

This simple class is a boundary condition for simple zero-dimensional models.

Definition at line 51 of file ZeroDimensionalBC.hpp.

Member Typedef Documentation

bcFunction_Type

typedef ZeroDimensionalFunction bcFunction_Type

Definition at line 58 of file ZeroDimensionalBC.hpp.

bcType_Type

typedef ZeroDimensionalBCType bcType_Type

Definition at line 59 of file ZeroDimensionalBC.hpp.

Constructor & Destructor Documentation

ZeroDimensionalBC() [1/2]

ZeroDimensionalBC ( )

inlineexplicit

Constructor.

Definition at line 68 of file ZeroDimensionalBC.hpp.

ZeroDimensionalBC() [2/2]

ZeroDimensionalBC ( const ZeroDimensionalBC &  bc )

inline

Definition at line 70 of file ZeroDimensionalBC.hpp.

~ZeroDimensionalBC()

virtual ~ZeroDimensionalBC ( )

inlinevirtual

Destructor.

Definition at line 75 of file ZeroDimensionalBC.hpp.

Member Function Documentation

evaluate()

Real evaluate ( const Real &  time ) const

inline

Evaluate the bc.

Parameters

time	the current time of the simulation

Returns

the bc value

Definition at line 88 of file ZeroDimensionalBC.hpp.

setBC()

void setBC ( const bcType_Type &  bcType, const bcFunction_Type &  bcFunction  )

inline

Set the function.

Parameters

function

the user defined function

Definition at line 103 of file ZeroDimensionalBC.hpp.

setBCFunction()

void setBCFunction ( const bcFunction_Type &  function )

inline

Set the function.

Parameters

function

the user defined function

Definition at line 113 of file ZeroDimensionalBC.hpp.

setBcType()

void setBcType ( const bcType_Type &  bcType )

inline

Set the type.

Parameters

bcType

the bc type

Definition at line 122 of file ZeroDimensionalBC.hpp.

bcType()

const bcType_Type& bcType ( ) const

inline

Get the type.

Returns

the bc type

Definition at line 137 of file ZeroDimensionalBC.hpp.

bcFunction()

const bcFunction_Type& bcFunction ( ) const

inline

Get the bc function.

Returns

the user defined bc function

Definition at line 146 of file ZeroDimensionalBC.hpp.

Field Documentation

M_bcType

bcType_Type M_bcType

private

Definition at line 155 of file ZeroDimensionalBC.hpp.

M_bcFunction

bcFunction_Type M_bcFunction

private

Definition at line 156 of file ZeroDimensionalBC.hpp.

---

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

• ZeroDimensionalBC.hpp