oofem::Field Class Reference

#include <field.h>

Inheritance diagram for oofem::Field:

Collaboration diagram for oofem::Field:

Public Member Functions
	Field (FieldType b=FieldType::FT_Unknown)
virtual	~Field ()
virtual int	evaluateAt (FloatArray &answer, const FloatArray &coords, ValueModeType mode, TimeStep *tStep)=0
virtual int	evaluateAt (FloatArray &answer, DofManager *dman, ValueModeType mode, TimeStep *tStep)=0
virtual int	evaluateAt (FloatArray &answer, Element *elem, ValueModeType mode, TimeStep *tStep)
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.
virtual void	saveContext (DataStream &stream)=0
virtual void	restoreContext (DataStream &stream)=0
std::string	errorInfo (const char *func) const
	Returns string for prepending output (used by error reporting macros).
virtual const char *	giveClassName () const =0
virtual void	initializeFrom (InputRecord &ir)

Protected Attributes
FieldType	type
IntArray	regionSets

Detailed Description

Abstract class representing field. Field represent the spatial distribution of certain variable. Field is able to evaluate its value at any point of interest. The field is usually associated to specific domain.

Definition at line 85 of file field.h.

Constructor & Destructor Documentation

Field()

oofem::Field::Field ( FieldType b = FieldType::FT_Unknown )

inline

Constructor. Creates a field of given type associated to given domain.

Definition at line 95 of file field.h.

References regionSets, and type.

Referenced by oofem::DofManValueField::DofManValueField(), oofem::DofManValueField::DofManValueField(), oofem::ExpressionField::ExpressionField(), oofem::InternalVariableField::InternalVariableField(), oofem::MaskedPrimaryField::MaskedPrimaryField(), oofem::PrimaryField::PrimaryField(), oofem::PythonField::PythonField(), oofem::SmoothedNodalInternalVariableField::SmoothedNodalInternalVariableField(), oofem::UniformGridField::UniformGridField(), oofem::UnstructuredGridField::UnstructuredGridField(), and oofem::VoxelVOFField::VoxelVOFField().

~Field()

virtual oofem::Field::~Field ( )

inlinevirtual

Definition at line 96 of file field.h.

Member Function Documentation

errorInfo()

std::string oofem::Field::errorInfo

(

const char *

func

)

const

Returns string for prepending output (used by error reporting macros).

Definition at line 66 of file field.C.

References giveClassName().

Referenced by restoreContext().

evaluateAt() [1/3]

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

pure virtual

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.

Implemented in oofem::DofManValueField, oofem::ExpressionField, oofem::InternalVariableField, oofem::MaskedPrimaryField, oofem::PrimaryField, oofem::PythonField, oofem::SmoothedNodalInternalVariableField, oofem::UniformGridField, oofem::UnstructuredGridField, and oofem::VoxelVOFField.

evaluateAt() [2/3]

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

pure virtual

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)

Implemented in oofem::DofManValueField, oofem::ExpressionField, oofem::InternalVariableField, oofem::MaskedPrimaryField, oofem::PrimaryField, oofem::PythonField, oofem::SmoothedNodalInternalVariableField, oofem::UniformGridField, oofem::UnstructuredGridField, and oofem::VoxelVOFField.

evaluateAt() [3/3]

virtual int oofem::Field::evaluateAt ( FloatArray & answer, Element * elem, ValueModeType mode, TimeStep * tStep )

inlinevirtual

Reimplemented in oofem::VoxelVOFField.

Definition at line 124 of file field.h.

giveClassName()

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

pure virtual

Returns

Class name of the receiver.

Implemented in oofem::DofManValueField, oofem::ExpressionField, oofem::InternalVariableField, oofem::MaskedPrimaryField, oofem::PrimaryField, oofem::PythonField, oofem::SmoothedNodalInternalVariableField, oofem::UniformGridField, oofem::UnstructuredGridField, and oofem::VoxelVOFField.

Referenced by errorInfo().

giveType()

FieldType oofem::Field::giveType ( )

inline

Returns the type of receiver.

Definition at line 128 of file field.h.

References type.

hasElementInSets()

bool oofem::Field::hasElementInSets ( int nElem, Domain * d )

virtual

Searches if element number exist in IntArray regionSets for given domain.

Definition at line 49 of file field.C.

References oofem::Domain::giveSet(), oofem::Set::hasElement(), and regionSets.

initializeFrom()

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

inlinevirtual

Reimplemented in oofem::ExpressionField, and oofem::VoxelVOFField.

Definition at line 159 of file field.h.

restoreContext()

virtual void oofem::Field::restoreContext ( DataStream & stream )

pure virtual

Restores the receiver state previously written in stream.

Parameters

stream

Input stream.

Exceptions

Throws

an ContextIOERR exception if error encountered.

Implemented in oofem::DofManValueField, oofem::ExpressionField, oofem::InternalVariableField, oofem::MaskedPrimaryField, oofem::PrimaryField, oofem::PythonField, oofem::SmoothedNodalInternalVariableField, oofem::UniformGridField, oofem::UnstructuredGridField, and oofem::VoxelVOFField.

References errorInfo().

saveContext()

virtual void oofem::Field::saveContext ( DataStream & stream )

pure virtual

Stores receiver state to output stream.

Parameters

stream

Output stream.

Exceptions

Throws

an ContextIOERR exception if error encountered.

Implemented in oofem::DofManValueField, oofem::ExpressionField, oofem::InternalVariableField, oofem::MaskedPrimaryField, oofem::PrimaryField, oofem::PythonField, oofem::SmoothedNodalInternalVariableField, oofem::UniformGridField, oofem::UnstructuredGridField, and oofem::VoxelVOFField.

setSetsNumbers()

void oofem::Field::setSetsNumbers

(

const IntArray

sets

)

Defines a list of sets used to impose a field on specific elements.

Definition at line 42 of file field.C.

References regionSets.

setType()

void oofem::Field::setType ( FieldType b )

inline

Sets the type of receiver.

Definition at line 131 of file field.h.

References type.

Member Data Documentation

regionSets

IntArray oofem::Field::regionSets

protected

Definition at line 89 of file field.h.

Referenced by Field(), hasElementInSets(), and setSetsNumbers().

type

FieldType oofem::Field::type

protected

Definition at line 88 of file field.h.

Referenced by oofem::UnstructuredGridField::addCell(), Field(), giveType(), oofem::ExpressionField::initializeFrom(), and setType().

---

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

• field.h
• field.C