BCInterfaceData0D - The BCInterface1D data container. More...

#include <BCInterfaceData0D.hpp>

Inheritance diagram for BCInterfaceData0D:

Collaboration diagram for BCInterfaceData0D:

Type definitions
typedef BCInterfaceData	dataContainer_Type

typedef ZeroDimensionalBCHandler::bcType_Type	bcType_Type

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

	BCInterfaceData0D (const BCInterfaceData0D &data)
	Copy constructor. More...

virtual	~BCInterfaceData0D ()
	Destructor. More...

Operators
BCInterfaceData0D &	operator= (const BCInterfaceData0D &data)
	Operator =. More...

Methods
void	readBC (const std::string &fileName, const std::string &dataSection, const std::string &name)
	Read parameters for all kind of BC. More...

void	showMe (std::ostream &output=std::cout) const
	Display general information about the content of the class. More...

Set Methods
void	setFlag (const bcFlag_Type &flag)
	Set the flag of the boundary condition. More...

void	setType (const bcType_Type &type)
	Set the type of the boundary condition. More...

Get Methods
const bcFlag_Type &	flag () const
	Get the flag of the boundary condition. More...

const bcType_Type &	type () const
	Get the type of the boundary condition. More...

Private Methods
void	readFlag (const GetPot &dataFile, const char *flag)

void	readType (const GetPot &dataFile, const char *type)

Private Members
bcType_Type	M_type

std::map< std::string, bcType_Type >	M_mapType

Additional Inherited Members
Public Types inherited from BCInterfaceData
typedef std::vector< Real >	parametersContainer_Type

Public Member Functions inherited from BCInterfaceData
	BCInterfaceData ()
	Constructor. More...

	BCInterfaceData (const BCInterfaceData &data)
	Copy constructor. More...

virtual	~BCInterfaceData ()
	Destructor. More...

BCInterfaceData &	operator= (const BCInterfaceData &data)
	Operator =. More...

void	setBaseString (const std::string &baseString)
	Set the base string of the boundary condition. More...

void	setBase (const std::pair< std::string, baseList_Type > &base)
	Set the base type of the boundary condition. More...

void	boundaryID (const ID &boundaryID)
	Set the boundary ID. More...

const std::string &	baseString () const
	Get the base string of the boundary condition. More...

const std::pair< std::string, baseList_Type > &	base () const
	Get the base type of the boundary condition. More...

const std::map< std::string, baseList_Type > &	mapBase () const
	Get the base map of the boundary condition. More...

const ID &	boundaryID () const
	Get the boundary ID. More...

const parametersContainer_Type &	parameters () const
	Get the parameters vector {A, B, C, ...}. More...

Protected Member Functions inherited from BCInterfaceData
void	readBase (const GetPot &dataFile, const std::string &path, std::pair< std::string, baseList_Type > &base, std::string &baseString)

bool	isBase (const GetPot &dataFile, const char *base, std::string &baseString)

void	readParameters (const GetPot &dataFile, const char *parameters)

Protected Attributes inherited from BCInterfaceData
std::pair< std::string, baseList_Type >	M_base

std::string	M_baseString

std::map< std::string, baseList_Type >	M_mapBase

ID	M_boundaryID

parametersContainer_Type	M_parameters

Detailed Description

BCInterfaceData0D - The BCInterface1D data container.

Author: Cristiano Malossi

The BCInterfaceData0D class provides a general container for all the data required by the 0D boundary conditions.

Definition at line 56 of file BCInterfaceData0D.hpp.

Member Typedef Documentation

◆ dataContainer_Type

typedef BCInterfaceData dataContainer_Type

Definition at line 63 of file BCInterfaceData0D.hpp.

◆ bcType_Type

typedef ZeroDimensionalBCHandler::bcType_Type bcType_Type

Definition at line 64 of file BCInterfaceData0D.hpp.

Constructor & Destructor Documentation

◆ BCInterfaceData0D() [1/2]

BCInterfaceData0D ( )

explicit

Constructor.

Definition at line 45 of file BCInterfaceData0D.cpp.

Here is the caller graph for this function:

◆ BCInterfaceData0D() [2/2]

BCInterfaceData0D ( const BCInterfaceData0D & data )

Copy constructor.

Parameters

data	BCInterfaceData0D

Definition at line 55 of file BCInterfaceData0D.cpp.

Here is the caller graph for this function:

◆ ~BCInterfaceData0D()

virtual ~BCInterfaceData0D ( )

inlinevirtual

Destructor.

Definition at line 82 of file BCInterfaceData0D.hpp.

Member Function Documentation

◆ operator=()

BCInterfaceData0D & operator= ( const BCInterfaceData0D & data )

Operator =.

Parameters

data	BCInterfaceData0D

Returns: reference to a copy of the class

Definition at line 66 of file BCInterfaceData0D.cpp.

◆ readBC()

void readBC	(	const std::string &	fileName,
		const std::string &	dataSection,
		const std::string &	name
	)

virtual

Read parameters for all kind of BC.

Parameters

fileName	Name of the data file.
dataSection	BC section
name	name of the boundary condition

Reimplemented from BCInterfaceData.

Definition at line 82 of file BCInterfaceData0D.cpp.

◆ showMe()

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

virtual

Display general information about the content of the class.

Parameters

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

Reimplemented from BCInterfaceData.

Definition at line 95 of file BCInterfaceData0D.cpp.

◆ setFlag()

void setFlag ( const bcFlag_Type & flag )

inline

Set the flag of the boundary condition.

Parameters

flag	Boundary condition flag

Definition at line 127 of file BCInterfaceData0D.hpp.

◆ setType()

void setType ( const bcType_Type & type )

inline

Set the type of the boundary condition.

Parameters

type	Boundary condition type

Definition at line 136 of file BCInterfaceData0D.hpp.

◆ flag()

const bcFlag_Type& flag ( ) const

inline

Get the flag of the boundary condition.

Returns: Boundary condition flag

Definition at line 151 of file BCInterfaceData0D.hpp.

◆ type()

const bcType_Type& type ( ) const

inline

Get the type of the boundary condition.

Returns: Boundary condition type

Definition at line 160 of file BCInterfaceData0D.hpp.

◆ readFlag()

void readFlag	(	const GetPot &	dataFile,
		const char *	flag
	)

inlineprivate

Definition at line 172 of file BCInterfaceData0D.hpp.

◆ readType()

void readType	(	const GetPot &	dataFile,
		const char *	type
	)

inlineprivate

Definition at line 177 of file BCInterfaceData0D.hpp.

Field Documentation

◆ M_type

bcType_Type M_type

private

Definition at line 189 of file BCInterfaceData0D.hpp.

◆ M_mapType

std::map< std::string, bcType_Type > M_mapType

private

Definition at line 193 of file BCInterfaceData0D.hpp.

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

Type definitions

Constructors & Destructor

Operators

Methods

Set Methods

Get Methods

Private Methods

Private Members

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ dataContainer_Type

◆ bcType_Type

Constructor & Destructor Documentation

◆ BCInterfaceData0D() [1/2]

◆ BCInterfaceData0D() [2/2]

◆ ~BCInterfaceData0D()

Member Function Documentation

◆ operator=()

◆ readBC()

◆ showMe()

◆ setFlag()

◆ setType()

◆ flag()

◆ type()

◆ readFlag()

◆ readType()

Field Documentation

◆ M_type

◆ M_mapType