BCInterfaceData3D - The BCInterface3D data container. More...

#include <BCInterfaceData3D.hpp>

Inheritance diagram for BCInterfaceData3D:

Collaboration diagram for BCInterfaceData3D:

Type definitions
typedef BCInterfaceData	dataContainer_Type

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

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

virtual	~BCInterfaceData3D ()
	Destructor. More...

Operators
BCInterfaceData3D &	operator= (const BCInterfaceData3D &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	setDirectionalBase ()
	Set the directional base as the current base. More...

void	setRobinBaseAlpha ()
	Set the Robin Alpha base as the current base. More...

void	setRobinBaseBeta ()
	Set the Robin Beta base as the current base. More...

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

Set Methods
void	setName (const bcName_Type &name)
	Set the name of the boundary condition. More...

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

void	setMode (const bcMode_Type &mode)
	Set the mode of the boundary condition. More...

void	setComponentsVector (const bcComponentsVec_Type &componentsVector)
	Set the components vector of the boundary condition. More...

void	setComponentsVector (const UInt &componentsVector, const UInt &index)
	Set the i-component of the components vector of the boundary condition. More...

void	addComponentsVector (const UInt &componentsVector)
	Add a component to the component vector of the boundary condition. More...

Get Methods
const bcName_Type &	name () const
	Get the name of the boundary condition. More...

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

const bcMode_Type &	mode () const
	Get the mode of the boundary condition. More...

const bcComponentsVec_Type &	componentsVector () const
	Get the vector of components of the boundary condition. More...

const ID &	componentsNumber () const
	Get the number of components of the boundary condition. More...

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

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

void	readMode (const GetPot &dataFile, const char *mode)

void	readComponentsVector (const GetPot &dataFile, const char *component)

Private Members
std::pair< std::string, baseList_Type >	M_baseRobinAlpha

std::string	M_baseStringRobinAlpha

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

std::string	M_baseStringRobinBeta

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

std::string	M_baseStringDirectional

bcName_Type	M_name

bcType_Type	M_type

bcMode_Type	M_mode

bcComponentsVec_Type	M_componentsVector

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

std::map< std::string, bcMode_Type >	M_mapMode

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

BCInterfaceData3D - The BCInterface3D data container.

Author: Cristiano Malossi

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

Definition at line 59 of file BCInterfaceData3D.hpp.

Member Typedef Documentation

◆ dataContainer_Type

typedef BCInterfaceData dataContainer_Type

Definition at line 66 of file BCInterfaceData3D.hpp.

Constructor & Destructor Documentation

◆ BCInterfaceData3D() [1/2]

BCInterfaceData3D ( )

explicit

Constructor.

Definition at line 45 of file BCInterfaceData3D.cpp.

Here is the caller graph for this function:

◆ BCInterfaceData3D() [2/2]

BCInterfaceData3D ( const BCInterfaceData3D & data )

Copy constructor.

Parameters

data	BCInterfaceData3D

Definition at line 78 of file BCInterfaceData3D.cpp.

Here is the caller graph for this function:

◆ ~BCInterfaceData3D()

virtual ~BCInterfaceData3D ( )

inlinevirtual

Destructor.

Definition at line 84 of file BCInterfaceData3D.hpp.

Member Function Documentation

◆ operator=()

BCInterfaceData3D & operator= ( const BCInterfaceData3D & data )

Operator =.

Parameters

data	BCInterfaceData3D

Returns: reference to a copy of the class

Definition at line 99 of file BCInterfaceData3D.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 125 of file BCInterfaceData3D.cpp.

◆ setDirectionalBase()

void setDirectionalBase ( )

inline

Set the directional base as the current base.

Definition at line 114 of file BCInterfaceData3D.hpp.

◆ setRobinBaseAlpha()

void setRobinBaseAlpha ( )

inline

Set the Robin Alpha base as the current base.

Definition at line 121 of file BCInterfaceData3D.hpp.

◆ setRobinBaseBeta()

void setRobinBaseBeta ( )

inline

Set the Robin Beta base as the current base.

Definition at line 128 of file BCInterfaceData3D.hpp.

◆ 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 153 of file BCInterfaceData3D.cpp.

◆ setName()

void setName ( const bcName_Type & name )

inline

Set the name of the boundary condition.

Parameters

name	Boundary condition name

Definition at line 150 of file BCInterfaceData3D.hpp.

◆ setFlag()

void setFlag ( const bcFlag_Type & flag )

inline

Set the flag of the boundary condition.

Parameters

flag	Boundary condition flag

Definition at line 159 of file BCInterfaceData3D.hpp.

◆ setType()

void setType ( const bcType_Type & type )

inline

Set the type of the boundary condition.

Parameters

type	Boundary condition type

Definition at line 168 of file BCInterfaceData3D.hpp.

◆ setMode()

void setMode ( const bcMode_Type & mode )

inline

Set the mode of the boundary condition.

Parameters

mode	Boundary condition mode

Definition at line 177 of file BCInterfaceData3D.hpp.

◆ setComponentsVector() [1/2]

void setComponentsVector ( const bcComponentsVec_Type & componentsVector )

inline

Set the components vector of the boundary condition.

Parameters

componentsVector Boundary condition components vector

Definition at line 186 of file BCInterfaceData3D.hpp.

◆ setComponentsVector() [2/2]

void setComponentsVector	(	const UInt &	componentsVector,
		const UInt &	index
	)

inline

Set the i-component of the components vector of the boundary condition.

Parameters

componentsVector	Boundary condition component
index	Index value

Definition at line 196 of file BCInterfaceData3D.hpp.

◆ addComponentsVector()

void addComponentsVector ( const UInt & componentsVector )

inline

Add a component to the component vector of the boundary condition.

Parameters

componentsVector Boundary condition component

Definition at line 205 of file BCInterfaceData3D.hpp.

◆ name()

const bcName_Type& name ( ) const

inline

Get the name of the boundary condition.

Returns: Boundary condition name

Definition at line 220 of file BCInterfaceData3D.hpp.

◆ flag()

const bcFlag_Type& flag ( ) const

inline

Get the flag of the boundary condition.

Returns: Boundary condition flag

Definition at line 229 of file BCInterfaceData3D.hpp.

◆ type()

const bcType_Type& type ( ) const

inline

Get the type of the boundary condition.

Returns: Boundary condition type

Definition at line 238 of file BCInterfaceData3D.hpp.

◆ mode()

const bcMode_Type& mode ( ) const

inline

Get the mode of the boundary condition.

Returns: Boundary condition mode

Definition at line 247 of file BCInterfaceData3D.hpp.

◆ componentsVector()

const bcComponentsVec_Type& componentsVector ( ) const

inline

Get the vector of components of the boundary condition.

Returns: Boundary condition vector of components

Definition at line 256 of file BCInterfaceData3D.hpp.

◆ componentsNumber()

const ID& componentsNumber ( ) const

inline

Get the number of components of the boundary condition.

Note that this method should not be called for the case of "Component" boundary conditions, since it does not return the size of the M_componentsVector. It has to be used only for the case of "Full" boundary conditions.

Returns: Number of components of the boundary condition

Definition at line 269 of file BCInterfaceData3D.hpp.

◆ readFlag()

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

inlineprivate

Definition at line 281 of file BCInterfaceData3D.hpp.

◆ readType()

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

inlineprivate

Definition at line 286 of file BCInterfaceData3D.hpp.

◆ readMode()

void readMode	(	const GetPot &	dataFile,
		const char *	mode
	)

inlineprivate

Definition at line 291 of file BCInterfaceData3D.hpp.

◆ readComponentsVector()

void readComponentsVector	(	const GetPot &	dataFile,
		const char *	component
	)

private

Definition at line 173 of file BCInterfaceData3D.cpp.

Field Documentation

◆ M_baseRobinAlpha

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

private

Definition at line 304 of file BCInterfaceData3D.hpp.

◆ M_baseStringRobinAlpha

std::string M_baseStringRobinAlpha

private

Definition at line 305 of file BCInterfaceData3D.hpp.

◆ M_baseRobinBeta

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

private

Definition at line 307 of file BCInterfaceData3D.hpp.

◆ M_baseStringRobinBeta

std::string M_baseStringRobinBeta

private

Definition at line 308 of file BCInterfaceData3D.hpp.

◆ M_baseDirectional

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

private

Definition at line 310 of file BCInterfaceData3D.hpp.

◆ M_baseStringDirectional

std::string M_baseStringDirectional

private

Definition at line 311 of file BCInterfaceData3D.hpp.

◆ M_name

bcName_Type M_name

private

Definition at line 313 of file BCInterfaceData3D.hpp.

◆ M_type

bcType_Type M_type

private

Definition at line 314 of file BCInterfaceData3D.hpp.

◆ M_mode

bcMode_Type M_mode

private

Definition at line 315 of file BCInterfaceData3D.hpp.

◆ M_componentsVector

bcComponentsVec_Type M_componentsVector

private

Definition at line 316 of file BCInterfaceData3D.hpp.

◆ M_mapType

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

private

Definition at line 319 of file BCInterfaceData3D.hpp.

◆ M_mapMode

std::map< std::string, bcMode_Type > M_mapMode

private

Definition at line 320 of file BCInterfaceData3D.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

Constructor & Destructor Documentation

◆ BCInterfaceData3D() [1/2]

◆ BCInterfaceData3D() [2/2]

◆ ~BCInterfaceData3D()

Member Function Documentation

◆ operator=()

◆ readBC()

◆ setDirectionalBase()

◆ setRobinBaseAlpha()

◆ setRobinBaseBeta()

◆ showMe()

◆ setName()

◆ setFlag()

◆ setType()

◆ setMode()

◆ setComponentsVector() [1/2]

◆ setComponentsVector() [2/2]

◆ addComponentsVector()

◆ name()

◆ flag()

◆ type()

◆ mode()

◆ componentsVector()

◆ componentsNumber()

◆ readFlag()

◆ readType()

◆ readMode()

◆ readComponentsVector()

Field Documentation

◆ M_baseRobinAlpha

◆ M_baseStringRobinAlpha

◆ M_baseRobinBeta

◆ M_baseStringRobinBeta

◆ M_baseDirectional

◆ M_baseStringDirectional

◆ M_name

◆ M_type

◆ M_mode

◆ M_componentsVector

◆ M_mapType

◆ M_mapMode