OOFEM 3.0
Loading...
Searching...
No Matches
oofem::InternalVariableField Class Reference

#include <intvarfield.h>

Inheritance diagram for oofem::InternalVariableField:
Collaboration diagram for oofem::InternalVariableField:

Public Member Functions

 InternalVariableField (InternalStateType ist, FieldType b, MaterialMappingAlgorithmType mma_type, Domain *d)
virtual ~InternalVariableField ()
int evaluateAt (FloatArray &answer, const FloatArray &coords, ValueModeType mode, TimeStep *tStep) override
int evaluateAt (FloatArray &answer, DofManager *dman, ValueModeType mode, TimeStep *tStep) override
void saveContext (DataStream &stream) override
void restoreContext (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

std::unique_ptr< MaterialMappingAlgorithmmma
 Material mapping algorithm used.
InternalStateType type
 InternalStateType.
Domaindomain
 Source domain.
Protected Attributes inherited from oofem::Field
FieldType type
IntArray regionSets

Detailed Description

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

It uses MaterialMappingAlgorithm interface to perform interpolation. Note, that some classes implementing MaterialMappingAlgorithm may require that elements implement corresponding interface.

Definition at line 57 of file intvarfield.h.

Constructor & Destructor Documentation

◆ InternalVariableField()

oofem::InternalVariableField::InternalVariableField ( InternalStateType ist,
FieldType b,
MaterialMappingAlgorithmType mma_type,
Domain * d )

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

Parameters
istPhysical meaning of field.
bField type.
mma_typeAlgorithm used to map materials.
dDomain which field belongs to.

Definition at line 41 of file intvarfield.C.

References oofem::classFactory, domain, oofem::Field::Field(), mma, and type.

◆ ~InternalVariableField()

virtual oofem::InternalVariableField::~InternalVariableField ( )
inlinevirtual

Definition at line 76 of file intvarfield.h.

Member Function Documentation

◆ evaluateAt() [1/2]

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

Evaluates the field at given point.

Parameters
coordsCoordinates of the point of interest
answerField evaluated at coordinate.
tStepTime step to evaluate for.
modeMode of value (total, velocity,...).
Returns
Zero if ok, otherwise nonzero.

Use MaterialMappingAlgorithm classes to do the job

Implements oofem::Field.

Definition at line 49 of file intvarfield.C.

References oofem::Set::addAllElements(), oofem::IntArray::at(), domain, mma, and type.

Referenced by evaluateAt().

◆ evaluateAt() [2/2]

int oofem::InternalVariableField::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]answerEvaluated field for dman.
dmanReference to dofManager.
modeMode of value (total, velocity,...).
tStepTime step to evaluate for.
Returns
Zero if ok, nonzero Error code (0-ok, 1-failed)

Implements oofem::Field.

Definition at line 63 of file intvarfield.C.

References evaluateAt(), and oofem::DofManager::giveCoordinates().

◆ giveClassName()

const char * oofem::InternalVariableField::giveClassName ( ) const
inlineoverridevirtual
Returns
Class name of the receiver.

Implements oofem::Field.

Definition at line 83 of file intvarfield.h.

◆ restoreContext()

void oofem::InternalVariableField::restoreContext ( DataStream & stream)
overridevirtual

Restores the receiver state previously written in stream.

Parameters
streamInput stream.
Exceptions
Throwsan ContextIOERR exception if error encountered.

Implements oofem::Field.

Definition at line 73 of file intvarfield.C.

◆ saveContext()

void oofem::InternalVariableField::saveContext ( DataStream & stream)
overridevirtual

Stores receiver state to output stream.

Parameters
streamOutput stream.
Exceptions
Throwsan ContextIOERR exception if error encountered.

Implements oofem::Field.

Definition at line 69 of file intvarfield.C.

Member Data Documentation

◆ domain

Domain* oofem::InternalVariableField::domain
protected

Source domain.

Definition at line 65 of file intvarfield.h.

Referenced by evaluateAt(), and InternalVariableField().

◆ mma

std::unique_ptr<MaterialMappingAlgorithm> oofem::InternalVariableField::mma
protected

Material mapping algorithm used.

Definition at line 61 of file intvarfield.h.

Referenced by evaluateAt(), and InternalVariableField().

◆ type

InternalStateType oofem::InternalVariableField::type
protected

InternalStateType.

Definition at line 63 of file intvarfield.h.

Referenced by evaluateAt(), and InternalVariableField().


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

This page is part of the OOFEM-3.0 documentation. Copyright Copyright (C) 1994-2025 Borek Patzak Bořek Patzák
Project e-mail: oofem@fsv.cvut.cz
Generated at for OOFEM by doxygen 1.15.0 written by Dimitri van Heesch, © 1997-2011