oofem::MaskedPrimaryField Class Reference

#include <maskedprimaryfield.h>

Inheritance diagram for oofem::MaskedPrimaryField:

Collaboration diagram for oofem::MaskedPrimaryField:

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

Protected Attributes
PrimaryField *	master
IntArray	mask
Protected Attributes inherited from oofem::Field
FieldType	type
IntArray	regionSets

Detailed Description

Abstract class representing subset of DOFs (identified by DofId mask) of primary field. As the PrimaryField stores the state directly in solution vectors that are usually directly updated by EngngModel, it may contain a mix of different fields (this is especially true for strongly coupled problems). Then masked primary field can be used to select only certain DOFs (based on DofID) from its master PrimaryField.

Definition at line 55 of file maskedprimaryfield.h.

Constructor & Destructor Documentation

MaskedPrimaryField()

oofem::MaskedPrimaryField::MaskedPrimaryField ( FieldType b, PrimaryField * m, IntArray dofIdMask )

inline

Definition at line 62 of file maskedprimaryfield.h.

References oofem::Field::Field(), mask, and master.

Member Function Documentation

evaluateAt() [1/2]

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

overridevirtual

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 39 of file maskedprimaryfield.C.

References mask, and master.

evaluateAt() [2/2]

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

overridevirtual

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 46 of file maskedprimaryfield.C.

References mask, and master.

giveClassName()

const char * oofem::MaskedPrimaryField::giveClassName ( ) const

inlineoverridevirtual

Returns

Class name of the receiver.

Implements oofem::Field.

Definition at line 73 of file maskedprimaryfield.h.

restoreContext()

void oofem::MaskedPrimaryField::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 70 of file maskedprimaryfield.h.

saveContext()

void oofem::MaskedPrimaryField::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 71 of file maskedprimaryfield.h.

Member Data Documentation

mask

IntArray oofem::MaskedPrimaryField::mask

protected

Definition at line 59 of file maskedprimaryfield.h.

Referenced by evaluateAt(), evaluateAt(), and MaskedPrimaryField().

master

PrimaryField* oofem::MaskedPrimaryField::master

protected

Definition at line 58 of file maskedprimaryfield.h.

Referenced by evaluateAt(), evaluateAt(), and MaskedPrimaryField().

---

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

• maskedprimaryfield.h
• maskedprimaryfield.C