ExporterData - Holds the data structure of the array to import/export. More...

#include <Exporter.hpp>

Collaboration diagram for ExporterData< MeshType >:

Public Types
enum	FieldTypeEnum { ScalarField, VectorField }
	FieldTypeEnum of data stored. More...

enum	WhereEnum { Node, Cell }
	Where is data centered? /. More...

enum	FieldRegimeEnum { UnsteadyRegime, SteadyRegime, NullRegime }
	Time regime of the field /. More...

typedef MeshType	mesh_Type

typedef VectorEpetra	vector_Type

typedef std::shared_ptr< vector_Type >	vectorPtr_Type

typedef FESpace< mesh_Type, MapEpetra >	feSpace_Type

typedef std::shared_ptr< feSpace_Type >	feSpacePtr_Type

Constructor & Destructor
	ExporterData (const FieldTypeEnum &fieldType, const std::string &variableName, const feSpacePtr_Type &feSpacePtr, const vectorPtr_Type &vectorPtr, const UInt &start, const FieldRegimeEnum &regime, const WhereEnum &where=Node)
	Constructor with all the data to be stored. More...

Operators
Real	operator() (const UInt i) const
	Accessor to component (const) More...

Real &	operator() (const UInt i)
	Accessor to component (reference) More...

Set Methods
void	setRegime (FieldRegimeEnum regime)
	set the time regime of the field More...

void	setWhere (WhereEnum where)
	set where is the variable located (Node or Cell) More...

Get Methods
const std::string &	variableName () const
	name assigned to this variable in output file More...

const UInt &	numDOF () const
	number of (scalar) DOFs of the variable More...

const UInt &	start () const
	address of first datum in the array More...

const FieldTypeEnum &	fieldType () const
	scalar or vector field More...

const vectorPtr_Type	storedArrayPtr () const
	shared pointer to array More...

FieldRegimeEnum	regime () const
	returns UnsteadyRegime (=0) if file name for postprocessing has to include time dependency More...

std::string	typeName () const
	returns Scalar or Vector strings More...

UInt	fieldDim () const
	returns 1 (if Scalar) or 3 (if Vector) More...

const WhereEnum &	where () const
	Node or Cell centered ? More...

std::string	whereName () const
	returns Node or Cell centered string More...

const feSpacePtr_Type &	feSpacePtr () const

Private data members
std::string	M_variableName
	name assigned to this variable in output file More...

feSpacePtr_Type	M_feSpacePtr
	pointer to the FESpace of the variable More...

vectorPtr_Type	M_storedArrayPtr
	pointer to storedArray More...

UInt	M_numDOF
	number of (scalar) DOFs of the variable More...

UInt	M_start
	address of first datum in the array More...

FieldTypeEnum	M_fieldType
	scalar or vector field More...

FieldRegimeEnum	M_regime
	equal to UnsteadyRegime if file name for postprocessing has to include time dependency More...

WhereEnum	M_where
	Node or Cell centered. More...

Detailed Description

template<typename MeshType>
class LifeV::ExporterData< MeshType >

ExporterData - Holds the data structure of the array to import/export.

Author: Simone Deparis simon.nosp@m.e.de.nosp@m.paris.nosp@m.@epf.nosp@m.l.ch

Date: 11-11-2008

This class holds the data structure of one datum to help the importer/exporter e.g. variable name, shared pointer to data, size, and few others.

Definition at line 70 of file Exporter.hpp.

Member Typedef Documentation

◆ mesh_Type

typedef MeshType mesh_Type

Definition at line 77 of file Exporter.hpp.

◆ vector_Type

typedef VectorEpetra vector_Type

Definition at line 78 of file Exporter.hpp.

◆ vectorPtr_Type

typedef std::shared_ptr<vector_Type> vectorPtr_Type

Definition at line 79 of file Exporter.hpp.

◆ feSpace_Type

typedef FESpace< mesh_Type, MapEpetra > feSpace_Type

Definition at line 80 of file Exporter.hpp.

◆ feSpacePtr_Type

typedef std::shared_ptr<feSpace_Type> feSpacePtr_Type

Definition at line 81 of file Exporter.hpp.

Member Enumeration Documentation

◆ FieldTypeEnum

enum FieldTypeEnum

FieldTypeEnum of data stored.

Enumerator
ScalarField	ScalarField stands for scalar field
VectorField	VectorField stands for vector field

Definition at line 84 of file Exporter.hpp.

◆ WhereEnum

enum WhereEnum

Where is data centered? /.

Enumerator
Node	Node centered
Cell	Cell centered

Definition at line 91 of file Exporter.hpp.

◆ FieldRegimeEnum

enum FieldRegimeEnum

Time regime of the field /.

Enumerator
UnsteadyRegime	The field is in unsteady regime
SteadyRegime	The field is in steady regime
NullRegime	DEPRECATED

Definition at line 98 of file Exporter.hpp.

Constructor & Destructor Documentation

◆ ExporterData()

ExporterData	(	const FieldTypeEnum &	fieldType,
		const std::string &	variableName,
		const feSpacePtr_Type &	feSpacePtr,
		const vectorPtr_Type &	vectorPtr,
		const UInt &	start,
		const FieldRegimeEnum &	regime,
		const WhereEnum &	where = `Node`
	)

Constructor with all the data to be stored.

Constructor with all the data to be stored

Parameters

fieldType	- scalar or vector field
variableName	- name assigned to this variable in output file
feSpacePtr	- shared pointer to variable FESpace
vectorPtr	- shared pointer to variable array
start	- address of first datum in the array to be stored. Useful in case you want to define a subrange of the vector *vec
regime	- if UnsteadyRegime, then the file name for postprocessing has to include time dependency
where	- where is variable located (Node or Cell)

Definition at line 529 of file Exporter.hpp.

Member Function Documentation

◆ operator()() [1/2]

Real operator() ( const UInt i ) const

Accessor to component (const)

Parameters

i	which component to access

Definition at line 551 of file Exporter.hpp.

◆ operator()() [2/2]

Real & operator() ( const UInt i )

Accessor to component (reference)

Parameters

i	which component to access

Definition at line 557 of file Exporter.hpp.

◆ setRegime()

void setRegime ( FieldRegimeEnum regime )

inline

set the time regime of the field

Definition at line 153 of file Exporter.hpp.

◆ setWhere()

void setWhere ( WhereEnum where )

inline

set where is the variable located (Node or Cell)

Definition at line 159 of file Exporter.hpp.

◆ variableName()

const std::string& variableName ( ) const

inline

name assigned to this variable in output file

Definition at line 170 of file Exporter.hpp.

◆ numDOF()

const UInt& numDOF ( ) const

inline

number of (scalar) DOFs of the variable

Definition at line 177 of file Exporter.hpp.

◆ start()

const UInt& start ( ) const

inline

address of first datum in the array

Definition at line 183 of file Exporter.hpp.

◆ fieldType()

const FieldTypeEnum& fieldType ( ) const

inline

scalar or vector field

Definition at line 189 of file Exporter.hpp.

◆ storedArrayPtr()

const vectorPtr_Type storedArrayPtr ( ) const

inline

shared pointer to array

Definition at line 195 of file Exporter.hpp.

◆ regime()

FieldRegimeEnum regime ( ) const

inline

returns UnsteadyRegime (=0) if file name for postprocessing has to include time dependency

Definition at line 201 of file Exporter.hpp.

◆ typeName()

std::string typeName ( ) const

returns Scalar or Vector strings

Definition at line 563 of file Exporter.hpp.

◆ fieldDim()

UInt fieldDim ( ) const

returns 1 (if Scalar) or 3 (if Vector)

Definition at line 578 of file Exporter.hpp.

◆ where()

const WhereEnum& where ( ) const

inline

Node or Cell centered ?

Definition at line 213 of file Exporter.hpp.

◆ whereName()

std::string whereName ( ) const

returns Node or Cell centered string

Definition at line 584 of file Exporter.hpp.

◆ feSpacePtr()

const feSpacePtr_Type& feSpacePtr ( ) const

inline

Definition at line 221 of file Exporter.hpp.

Field Documentation

◆ M_variableName

std::string M_variableName

private

name assigned to this variable in output file

Definition at line 231 of file Exporter.hpp.

◆ M_feSpacePtr

feSpacePtr_Type M_feSpacePtr

private

pointer to the FESpace of the variable

Definition at line 234 of file Exporter.hpp.

◆ M_storedArrayPtr

vectorPtr_Type M_storedArrayPtr

private

pointer to storedArray

Definition at line 237 of file Exporter.hpp.

◆ M_numDOF

UInt M_numDOF

private

number of (scalar) DOFs of the variable

Definition at line 240 of file Exporter.hpp.

◆ M_start

UInt M_start

private

address of first datum in the array

Definition at line 243 of file Exporter.hpp.

◆ M_fieldType

FieldTypeEnum M_fieldType

private

scalar or vector field

Definition at line 246 of file Exporter.hpp.

◆ M_regime

FieldRegimeEnum M_regime

private

equal to UnsteadyRegime if file name for postprocessing has to include time dependency

Definition at line 249 of file Exporter.hpp.

◆ M_where

WhereEnum M_where

private

Node or Cell centered.

Definition at line 252 of file Exporter.hpp.

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

Exporter.hpp

Public Types

Constructor & Destructor

Operators

Set Methods

Get Methods

Private data members

Detailed Description

template<typename MeshType> class LifeV::ExporterData< MeshType >

Member Typedef Documentation

◆ mesh_Type

◆ vector_Type

◆ vectorPtr_Type

◆ feSpace_Type

◆ feSpacePtr_Type

Member Enumeration Documentation

◆ FieldTypeEnum

◆ WhereEnum

◆ FieldRegimeEnum

Constructor & Destructor Documentation

◆ ExporterData()

Member Function Documentation

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ setRegime()

◆ setWhere()

◆ variableName()

◆ numDOF()

◆ start()

◆ fieldType()

◆ storedArrayPtr()

◆ regime()

◆ typeName()

◆ fieldDim()

◆ where()

◆ whereName()

◆ feSpacePtr()

Field Documentation

◆ M_variableName

◆ M_feSpacePtr

◆ M_storedArrayPtr

◆ M_numDOF

◆ M_start

◆ M_fieldType

◆ M_regime

◆ M_where

template<typename MeshType>
class LifeV::ExporterData< MeshType >