BCInterfaceData1D - The BCInterface1D data container. More...

#include <BCInterfaceData1D.hpp>

Inheritance diagram for BCInterfaceData1D:

Collaboration diagram for BCInterfaceData1D:

Type definitions
typedef BCInterfaceData	dataContainer_Type

typedef std::vector< Real >	resistanceContainer_Type

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

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

virtual	~BCInterfaceData1D ()
	Destructor. More...

Operators
BCInterfaceData1D &	operator= (const BCInterfaceData1D &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	setSide (const OneDFSI::bcSide_Type &side)
	Set the side of the boundary condition. More...

void	setLine (const OneDFSI::bcLine_Type &line)
	Set the line of the boundary condition. More...

void	setQuantity (const OneDFSI::bcType_Type &quantity)
	Set the quantity of the boundary condition. More...

Get Methods
OneDFSI::bcSide_Type	side () const
	Get the flag of the boundary condition. More...

const OneDFSI::bcLine_Type &	line () const
	Get the mode of the boundary condition. More...

const OneDFSI::bcType_Type &	quantity () const
	Get the quantity of the boundary condition. More...

const resistanceContainer_Type &	resistance () const
	Get the resistance vector {R1, R2, R3 ...}. More...

const Real &	capacitance () const
	Get the capacitance. More...

Private Methods
void	readSide (const GetPot &dataFile, const char *side)

void	readLine (const GetPot &dataFile, const char *line)

void	readQuantity (const GetPot &dataFile, const char *quantity)

void	readResistance (const GetPot &dataFile, const char *resistance)

void	readCapacitance (const GetPot &dataFile, const char *capacitance)

Private Members
OneDFSI::bcLine_Type	M_line

OneDFSI::bcType_Type	M_quantity

resistanceContainer_Type	M_resistance

Real	M_capacitance

std::map< std::string, OneDFSI::bcSide_Type >	M_mapSide

std::map< std::string, OneDFSI::bcType_Type >	M_mapQuantity

std::map< std::string, OneDFSI::bcLine_Type >	M_mapLine

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

BCInterfaceData1D - The BCInterface1D data container.

Author: Cristiano Malossi

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

Definition at line 56 of file BCInterfaceData1D.hpp.

Member Typedef Documentation

◆ dataContainer_Type

typedef BCInterfaceData dataContainer_Type

Definition at line 63 of file BCInterfaceData1D.hpp.

◆ resistanceContainer_Type

typedef std::vector< Real > resistanceContainer_Type

Definition at line 64 of file BCInterfaceData1D.hpp.

Constructor & Destructor Documentation

◆ BCInterfaceData1D() [1/2]

BCInterfaceData1D ( )

explicit

Constructor.

Definition at line 45 of file BCInterfaceData1D.cpp.

Here is the caller graph for this function:

◆ BCInterfaceData1D() [2/2]

BCInterfaceData1D ( const BCInterfaceData1D & data )

Copy constructor.

Parameters

data	BCInterfaceData1D

Definition at line 72 of file BCInterfaceData1D.cpp.

Here is the caller graph for this function:

◆ ~BCInterfaceData1D()

virtual ~BCInterfaceData1D ( )

inlinevirtual

Destructor.

Definition at line 82 of file BCInterfaceData1D.hpp.

Member Function Documentation

◆ operator=()

BCInterfaceData1D & operator= ( const BCInterfaceData1D & data )

Operator =.

Parameters

data	BCInterfaceData1D

Returns: reference to a copy of the class

Definition at line 88 of file BCInterfaceData1D.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 109 of file BCInterfaceData1D.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 125 of file BCInterfaceData1D.cpp.

◆ setSide()

void setSide ( const OneDFSI::bcSide_Type & side )

inline

Set the side of the boundary condition.

Parameters

side	Boundary condition side

Definition at line 127 of file BCInterfaceData1D.hpp.

◆ setLine()

void setLine ( const OneDFSI::bcLine_Type & line )

inline

Set the line of the boundary condition.

Parameters

line	Boundary condition line

Definition at line 136 of file BCInterfaceData1D.hpp.

◆ setQuantity()

void setQuantity ( const OneDFSI::bcType_Type & quantity )

inline

Set the quantity of the boundary condition.

Parameters

quantity Boundary condition quantity

Definition at line 145 of file BCInterfaceData1D.hpp.

◆ side()

OneDFSI::bcSide_Type side ( ) const

inline

Get the flag of the boundary condition.

Returns: Boundary condition side

Definition at line 160 of file BCInterfaceData1D.hpp.

◆ line()

const OneDFSI::bcLine_Type& line ( ) const

inline

Get the mode of the boundary condition.

Returns: Boundary condition line

Definition at line 169 of file BCInterfaceData1D.hpp.

◆ quantity()

const OneDFSI::bcType_Type& quantity ( ) const

inline

Get the quantity of the boundary condition.

Returns: Boundary condition quantity

Definition at line 178 of file BCInterfaceData1D.hpp.

◆ resistance()

const resistanceContainer_Type& resistance ( ) const

inline

Get the resistance vector {R1, R2, R3 ...}.

Returns: Boundary condition resistance vector

Definition at line 187 of file BCInterfaceData1D.hpp.

◆ capacitance()

const Real& capacitance ( ) const

inline

Get the capacitance.

Returns: Boundary condition capacitance

Definition at line 196 of file BCInterfaceData1D.hpp.

◆ readSide()

void readSide	(	const GetPot &	dataFile,
		const char *	side
	)

inlineprivate

Definition at line 208 of file BCInterfaceData1D.hpp.

◆ readLine()

void readLine	(	const GetPot &	dataFile,
		const char *	line
	)

inlineprivate

Definition at line 213 of file BCInterfaceData1D.hpp.

◆ readQuantity()

void readQuantity	(	const GetPot &	dataFile,
		const char *	quantity
	)

inlineprivate

Definition at line 218 of file BCInterfaceData1D.hpp.

◆ readResistance()

void readResistance	(	const GetPot &	dataFile,
		const char *	resistance
	)

private

Definition at line 146 of file BCInterfaceData1D.cpp.

◆ readCapacitance()

void readCapacitance	(	const GetPot &	dataFile,
		const char *	capacitance
	)

inlineprivate

Definition at line 225 of file BCInterfaceData1D.hpp.

Field Documentation

◆ M_line

OneDFSI::bcLine_Type M_line

private

Definition at line 236 of file BCInterfaceData1D.hpp.

◆ M_quantity

OneDFSI::bcType_Type M_quantity

private

Definition at line 237 of file BCInterfaceData1D.hpp.

◆ M_resistance

resistanceContainer_Type M_resistance

private

Definition at line 239 of file BCInterfaceData1D.hpp.

◆ M_capacitance

Real M_capacitance

private

Definition at line 240 of file BCInterfaceData1D.hpp.

◆ M_mapSide

std::map< std::string, OneDFSI::bcSide_Type > M_mapSide

private

Definition at line 243 of file BCInterfaceData1D.hpp.

◆ M_mapQuantity

std::map< std::string, OneDFSI::bcType_Type > M_mapQuantity

private

Definition at line 244 of file BCInterfaceData1D.hpp.

◆ M_mapLine

std::map< std::string, OneDFSI::bcLine_Type > M_mapLine

private

Definition at line 245 of file BCInterfaceData1D.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

◆ resistanceContainer_Type

Constructor & Destructor Documentation

◆ BCInterfaceData1D() [1/2]

◆ BCInterfaceData1D() [2/2]

◆ ~BCInterfaceData1D()

Member Function Documentation

◆ operator=()

◆ readBC()

◆ showMe()

◆ setSide()

◆ setLine()

◆ setQuantity()

◆ side()

◆ line()

◆ quantity()

◆ resistance()

◆ capacitance()

◆ readSide()

◆ readLine()

◆ readQuantity()

◆ readResistance()

◆ readCapacitance()

Field Documentation

◆ M_line

◆ M_quantity

◆ M_resistance

◆ M_capacitance

◆ M_mapSide

◆ M_mapQuantity

◆ M_mapLine