BCInterfaceData - The BCInterface data container. More...

#include <BCInterfaceData.hpp>

Inheritance diagram for BCInterfaceData:

Collaboration diagram for BCInterfaceData:

Type definitions
typedef std::vector< Real >	parametersContainer_Type

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

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

virtual	~BCInterfaceData ()
	Destructor. More...

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

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

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

Set Methods
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...

Get Methods
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...

Private Methods
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)

Common Private Members
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

BCInterfaceData - The BCInterface data container.

Author: Cristiano Malossi

The BCInterfaceData class provides a general interface for the data container in order to pass information to all the BCInterface classes.

Definition at line 52 of file BCInterfaceData.hpp.

Member Typedef Documentation

◆ parametersContainer_Type

typedef std::vector< Real > parametersContainer_Type

Definition at line 59 of file BCInterfaceData.hpp.

Constructor & Destructor Documentation

◆ BCInterfaceData() [1/2]

BCInterfaceData ( )

explicit

Constructor.

Definition at line 45 of file BCInterfaceData.cpp.

Here is the caller graph for this function:

◆ BCInterfaceData() [2/2]

BCInterfaceData ( const BCInterfaceData & data )

Copy constructor.

Parameters

data	BCInterfaceData

Definition at line 62 of file BCInterfaceData.cpp.

Here is the caller graph for this function:

◆ ~BCInterfaceData()

virtual ~BCInterfaceData ( )

inlinevirtual

Destructor.

Definition at line 77 of file BCInterfaceData.hpp.

Member Function Documentation

◆ operator=()

BCInterfaceData & operator= ( const BCInterfaceData & data )

Operator =.

Parameters

data	BCInterfaceData

Returns: reference to a copy of the class

Definition at line 75 of file BCInterfaceData.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 in BCInterfaceData3D, BCInterfaceData0D, and BCInterfaceData1D.

Definition at line 93 of file BCInterfaceData.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 in BCInterfaceData3D, BCInterfaceData0D, and BCInterfaceData1D.

Definition at line 105 of file BCInterfaceData.cpp.

◆ setBaseString()

void setBaseString ( const std::string & baseString )

Set the base string of the boundary condition.

Parameters

baseString Boundary condition base string

Definition at line 123 of file BCInterfaceData.cpp.

◆ setBase()

void setBase ( const std::pair< std::string, baseList_Type > & base )

inline

Set the base type of the boundary condition.

Parameters

base	Boundary condition base type

Definition at line 128 of file BCInterfaceData.hpp.

◆ boundaryID() [1/2]

void boundaryID ( const ID & boundaryID )

inline

Set the boundary ID.

Parameters

boundaryID boundary ID

Definition at line 137 of file BCInterfaceData.hpp.

◆ baseString()

const std::string& baseString ( ) const

inline

Get the base string of the boundary condition.

Returns: Boundary condition base string

Definition at line 152 of file BCInterfaceData.hpp.

◆ base()

const std::pair< std::string, baseList_Type >& base ( ) const

inline

Get the base type of the boundary condition.

Returns: Boundary condition base

Definition at line 161 of file BCInterfaceData.hpp.

◆ mapBase()

const std::map< std::string, baseList_Type >& mapBase ( ) const

inline

Get the base map of the boundary condition.

Returns: Boundary condition base map

Definition at line 170 of file BCInterfaceData.hpp.

◆ boundaryID() [2/2]

const ID& boundaryID ( ) const

inline

Get the boundary ID.

Returns: boundaryID

Definition at line 179 of file BCInterfaceData.hpp.

◆ parameters()

const parametersContainer_Type& parameters ( ) const

inline

Get the parameters vector {A, B, C, ...}.

Returns: Boundary condition parameters vector

Definition at line 188 of file BCInterfaceData.hpp.

◆ readBase()

void readBase	(	const GetPot &	dataFile,
		const std::string &	path,
		std::pair< std::string, baseList_Type > &	base,
		std::string &	baseString
	)

protected

Definition at line 141 of file BCInterfaceData.cpp.

◆ isBase()

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

protected

Definition at line 154 of file BCInterfaceData.cpp.

◆ readParameters()

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

protected

Definition at line 162 of file BCInterfaceData.cpp.

Field Documentation

◆ M_base

std::pair< std::string, baseList_Type > M_base

protected

Definition at line 212 of file BCInterfaceData.hpp.

◆ M_baseString

std::string M_baseString

protected

Definition at line 213 of file BCInterfaceData.hpp.

◆ M_mapBase

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

protected

Definition at line 215 of file BCInterfaceData.hpp.

◆ M_boundaryID

ID M_boundaryID

protected

Definition at line 217 of file BCInterfaceData.hpp.

◆ M_parameters

parametersContainer_Type M_parameters

protected

Definition at line 219 of file BCInterfaceData.hpp.

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

Type definitions

Constructors & Destructor

Operators

Methods

Set Methods

Get Methods

Private Methods

Common Private Members

Detailed Description

Member Typedef Documentation

◆ parametersContainer_Type

Constructor & Destructor Documentation

◆ BCInterfaceData() [1/2]

◆ BCInterfaceData() [2/2]

◆ ~BCInterfaceData()

Member Function Documentation

◆ operator=()

◆ readBC()

◆ showMe()

◆ setBaseString()

◆ setBase()

◆ boundaryID() [1/2]

◆ baseString()

◆ base()

◆ mapBase()

◆ boundaryID() [2/2]

◆ parameters()

◆ readBase()

◆ isBase()

◆ readParameters()

Field Documentation

◆ M_base

◆ M_baseString

◆ M_mapBase

◆ M_boundaryID

◆ M_parameters