oofem::VoxelVOFField Class Reference

#include <voxelvoffield.h>

Inheritance diagram for oofem::VoxelVOFField:

Collaboration diagram for oofem::VoxelVOFField:

Public Member Functions
	VoxelVOFField (VoxelGrid *vg=nullptr)
void	setGrid (VoxelGrid *vg)
int	evaluateAt (FloatArray &answer, const FloatArray &coords, ValueModeType mode, TimeStep *tStep) override
int	evaluateAt (FloatArray &answer, DofManager *dman, ValueModeType mode, TimeStep *tStep) override
int	evaluateAt (FloatArray &answer, Element *el, ValueModeType mode, TimeStep *tStep) override
void	saveContext (DataStream &stream) override
void	restoreContext (DataStream &stream) override
virtual const char *	giveClassName () const override
virtual void	initializeFrom (InputRecord &ir) override
Public Member Functions inherited from oofem::Field
	Field (FieldType b=FieldType::FT_Unknown)
virtual	~Field ()
FieldType	giveType ()
	Returns the type of receiver.
void	setType (FieldType b)
	Sets the type of receiver.
void	setSetsNumbers (const IntArray sets)
	Defines a list of sets used to impose a field on specific elements.
virtual bool	hasElementInSets (int nElem, Domain *d)
	Searches if element number exist in IntArray regionSets for given domain.
std::string	errorInfo (const char *func) const
	Returns string for prepending output (used by error reporting macros).

Protected Attributes
VoxelGrid *	voxelGrid
Protected Attributes inherited from oofem::Field
FieldType	type
IntArray	regionSets

Detailed Description

Definition at line 47 of file voxelvoffield.h.

Constructor & Destructor Documentation

VoxelVOFField()

oofem::VoxelVOFField::VoxelVOFField ( VoxelGrid * vg = nullptr )

inline

Definition at line 52 of file voxelvoffield.h.

References oofem::Field::Field(), and voxelGrid.

Member Function Documentation

evaluateAt() [1/3]

int oofem::VoxelVOFField::evaluateAt ( FloatArray & answer, const FloatArray & coords, ValueModeType mode, TimeStep * tStep )

inlineoverridevirtual

Evaluates the field at given point.

Parameters

coords	Coordinates of the point of interest
answer	Field evaluated at coordinate.
tStep	Time step to evaluate for.
mode	Mode of value (total, velocity,...).

Returns

Zero if ok, otherwise nonzero.

Implements oofem::Field.

Definition at line 54 of file voxelvoffield.h.

References oofem::TimeStep::giveIntrinsicTime(), oofem::FloatArray::resize(), and voxelGrid.

evaluateAt() [2/3]

int oofem::VoxelVOFField::evaluateAt ( FloatArray & answer, DofManager * dman, ValueModeType mode, TimeStep * tStep )

inlineoverridevirtual

Evaluates the field at given DofManager. This potentially can be resolved quickly, as receiver data may be described using values at dofManagers. Here an additional issue exists: one needs to make sure, that passed dman is from the same domain, so that its number can be used to perform suggested quick evaluation.

If this is not the case (the field is described differently), the response can be evaluated using dofman coordinates in a standard way.

Parameters

[out]	answer	Evaluated field for dman.
	dman	Reference to dofManager.
	mode	Mode of value (total, velocity,...).
	tStep	Time step to evaluate for.

Returns

Zero if ok, nonzero Error code (0-ok, 1-failed)

Implements oofem::Field.

Definition at line 68 of file voxelvoffield.h.

References oofem::FloatArray::resize().

evaluateAt() [3/3]

int oofem::VoxelVOFField::evaluateAt ( FloatArray & answer, Element * el, ValueModeType mode, TimeStep * tStep )

inlineoverridevirtual

Reimplemented from oofem::Field.

Definition at line 75 of file voxelvoffield.h.

References oofem::FloatArray::add(), oofem::DofManager::giveCoordinates(), oofem::TimeStep::giveIntrinsicTime(), oofem::Element::giveNode(), oofem::Element::giveNumberOfNodes(), and voxelGrid.

giveClassName()

virtual const char * oofem::VoxelVOFField::giveClassName ( ) const

inlineoverridevirtual

Returns

Class name of the receiver.

Implements oofem::Field.

Definition at line 102 of file voxelvoffield.h.

initializeFrom()

virtual void oofem::VoxelVOFField::initializeFrom ( InputRecord & ir )

inlineoverridevirtual

Reimplemented from oofem::Field.

Definition at line 107 of file voxelvoffield.h.

restoreContext()

void oofem::VoxelVOFField::restoreContext ( DataStream & stream )

inlineoverridevirtual

Restores the receiver state previously written in stream.

Parameters

stream

Input stream.

Exceptions

Throws

an ContextIOERR exception if error encountered.

Implements oofem::Field.

Definition at line 98 of file voxelvoffield.h.

saveContext()

void oofem::VoxelVOFField::saveContext ( DataStream & stream )

inlineoverridevirtual

Stores receiver state to output stream.

Parameters

stream

Output stream.

Exceptions

Throws

an ContextIOERR exception if error encountered.

Implements oofem::Field.

Definition at line 97 of file voxelvoffield.h.

setGrid()

void oofem::VoxelVOFField::setGrid ( VoxelGrid * vg )

inline

Definition at line 53 of file voxelvoffield.h.

References voxelGrid.

Member Data Documentation

voxelGrid

VoxelGrid* oofem::VoxelVOFField::voxelGrid

protected

Definition at line 50 of file voxelvoffield.h.

Referenced by evaluateAt(), evaluateAt(), setGrid(), and VoxelVOFField().

---

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

• voxelvoffield.h