coupling::configurations::CouplingCellConfiguration< dim > Class Template Reference

configuration for output of coupling cell data to vtk files. More...

#include <CouplingCellConfiguration.h>

Inheritance diagram for coupling::configurations::CouplingCellConfiguration< dim >:

Collaboration diagram for coupling::configurations::CouplingCellConfiguration< dim >:

Public Member Functions
	CouplingCellConfiguration ()
	~CouplingCellConfiguration ()
void	parseSubtag (tinyxml2::XMLElement *node)
std::string	getTag () const
bool	isValid () const
tarch::la::Vector< dim, double >	getCouplingCellSize () const
tarch::la::Vector< dim, unsigned int >	getNumberLinkedCellsPerCouplingCell () const
unsigned int	getWriteEveryMicroscopicTimestep () const
std::string	getMicroscopicFilename () const
unsigned int	getWriteEveryMacroscopicTimestep () const
std::string	getMacroscopicFilename () const
Public Member Functions inherited from tarch::configuration::Configuration
virtual	~Configuration ()

Protected Member Functions
	CouplingCellConfiguration (tarch::la::Vector< dim, double > couplingCellSize, tarch::la::Vector< dim, unsigned int > linkedCellsPerCouplingCell, unsigned int writeEveryMicroscopicTimestep, std::string microscopicFilename, unsigned int writeEveryMacroscopicTimestep, std::string macroscopicFilename)

Private Attributes
bool	_isValid
tarch::la::Vector< dim, double >	_couplingCellSize
tarch::la::Vector< dim, unsigned int >	_linkedCellsPerCouplingCell
unsigned int	_writeEveryMicroscopicTimestep
std::string	_microscopicFilename
unsigned int	_writeEveryMacroscopicTimestep
std::string	_macroscopicFilename

Static Private Attributes
static const std::string	COUPLING_CELL_SIZE
static const std::string	LINKED_CELLS_PER_COUPLING_CELL
static const std::string	WRITE_EVERY_MICROSCOPIC_TIMESTEP
static const std::string	WRITE_EVERY_MACROSCOPIC_TIMESTEP
static const std::string	MICROSCOPIC_FILENAME
static const std::string	MACROSCOPIC_FILENAME

Detailed Description

template<unsigned int dim>
class coupling::configurations::CouplingCellConfiguration< dim >

configuration for output of coupling cell data to vtk files.

configuration for output of coupling cell data to vtk files. Derive from the class tarch::configuration::Configuration

Template Parameters

dim	Number of dimensions; it can be 1, 2 or 3

Author

Philipp Neumann

Constructor & Destructor Documentation

CouplingCellConfiguration()

template<unsigned int dim>

coupling::configurations::CouplingCellConfiguration< dim >::CouplingCellConfiguration ( )

inline

Constructor, initializes the class

~CouplingCellConfiguration()

template<unsigned int dim>

coupling::configurations::CouplingCellConfiguration< dim >::~CouplingCellConfiguration ( )

inline

Destructor

Member Function Documentation

getCouplingCellSize()

template<unsigned int dim>

tarch::la::Vector< dim, double > coupling::configurations::CouplingCellConfiguration< dim >::getCouplingCellSize ( ) const

inline

Returns the coupling cell size

Returns

_couplingCellSize

getMacroscopicFilename()

template<unsigned int dim>

std::string coupling::configurations::CouplingCellConfiguration< dim >::getMacroscopicFilename ( ) const

inline

Returns the macroscopic file name

Returns

_maroscopicFilename

getMicroscopicFilename()

template<unsigned int dim>

std::string coupling::configurations::CouplingCellConfiguration< dim >::getMicroscopicFilename ( ) const

inline

Returns the microscopic file name

Returns

_microscopicFilename

getNumberLinkedCellsPerCouplingCell()

template<unsigned int dim>

tarch::la::Vector< dim, unsigned int > coupling::configurations::CouplingCellConfiguration< dim >::getNumberLinkedCellsPerCouplingCell ( ) const

inline

Returns the number of linked cell encapsulated within a coupling cell

Returns

_linkedCellsPerCouplingCell

getTag()

template<unsigned int dim>

std::string coupling::configurations::CouplingCellConfiguration< dim >::getTag ( ) const

virtual

Returns name of xml tag that is associated to the configuration.

Returns

name of xml tag that is associated to the configuration

Implements tarch::configuration::Configuration.

getWriteEveryMacroscopicTimestep()

template<unsigned int dim>

unsigned int coupling::configurations::CouplingCellConfiguration< dim >::getWriteEveryMacroscopicTimestep ( ) const

inline

Returns step interval, at which the macro infos is to be written out

Returns

_writeEveryMacroscopicTimestep

getWriteEveryMicroscopicTimestep()

template<unsigned int dim>

unsigned int coupling::configurations::CouplingCellConfiguration< dim >::getWriteEveryMicroscopicTimestep ( ) const

inline

Returns step interval, at which the micro infos is to be written out

Returns

_writeEveryMicroscopicTimestep

isValid()

template<unsigned int dim>

bool coupling::configurations::CouplingCellConfiguration< dim >::isValid ( ) const

inlinevirtual

checks if the configuration is valid. This operation usually fails, if e.g. 1. parseSubtag() hasn't been called, i.e. configuration has not been used, or 2. parseSubtag() failed due to a wrong file.

Returns

_isValid

Implements tarch::configuration::Configuration.

parseSubtag()

template<unsigned int dim>

void coupling::configurations::CouplingCellConfiguration< dim >::parseSubtag ( tinyxml2::XMLElement * node )

virtual

parseSubtag

Parameters

node

Implements tarch::configuration::Configuration.

---

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

• coupling/configurations/CouplingCellConfiguration.h