#include <primaryfield.h>

Inheritance diagram for oofem::PrimaryField:

Collaboration diagram for oofem::PrimaryField:

Public Member Functions
	PrimaryField (EngngModel *a, int idomain, FieldType ft, int nHist)
virtual	~PrimaryField ()
virtual void	initialize (ValueModeType mode, TimeStep *tStep, FloatArray &answer, const UnknownNumberingScheme &s)
void	storeDofManager (TimeStep *tStep, DofManager &dman)
void	storeInDofDictionaries (TimeStep *tStep)
void	readDofManager (TimeStep *tStep, DofManager &dman)
void	readFromDofDictionaries (TimeStep *tStep)
virtual void	applyDefaultInitialCondition ()
void	applyInitialCondition (InitialCondition &ic)
virtual void	applyBoundaryCondition (TimeStep *tStep)
void	applyBoundaryCondition (BoundaryCondition &bc, TimeStep *tStep)
virtual double	giveUnknownValue (Dof dof, ValueModeType mode, TimeStep tStep)
int	evaluateAt (FloatArray &answer, const FloatArray &coords, ValueModeType mode, TimeStep *tStep) override
int	evaluateAt (FloatArray &answer, DofManager dman, ValueModeType mode, TimeStep tStep) override
virtual int	__evaluateAt (FloatArray &answer, DofManager dman, ValueModeType mode, TimeStep tStep, IntArray *dofId)
virtual int	__evaluateAt (FloatArray &answer, const FloatArray &coords, ValueModeType mode, TimeStep tStep, IntArray dofId)
virtual FloatArray *	giveSolutionVector (TimeStep *tStep)
virtual void	update (ValueModeType mode, TimeStep *tStep, const FloatArray &vectorToStore, const UnknownNumberingScheme &s)
virtual void	advanceSolution (TimeStep *tStep)
void	saveContext (DataStream &stream) override
void	restoreContext (DataStream &stream) override
const char *	giveClassName () const override
int	giveActualStepNumber ()
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 Member Functions
int	resolveIndx (TimeStep *tStep, int shift)
FloatArray *	giveSolutionVector (int)
FloatArray *	givePrescribedVector (int)

Protected Attributes
int	actualStepNumber
int	actualStepIndx
int	nHistVectors
std ::vector< FloatArray >	solutionVectors
std ::vector< FloatArray >	prescribedVectors
std ::vector< TimeStep >	solStepList
EngngModel *	emodel
int	domainIndx
Protected Attributes inherited from oofem::Field
FieldType	type
IntArray	regionSets

Detailed Description

Abstract class representing field of primary variables (those, which are unknown and are typically associated to nodes). In the current design the primary field is understood as simple database, that allows to keep track of the history of a solution vector representing primary field. The history is kept as sequence of solution vectors. The history depth kept can be selected. PrimaryField class basically provides access to time-dependent vectors of the field of unknowns. It adds the possibility to further interpolate the field values using element interpolation functions. The prescribed values of the field are not maintained, since they can be obtained directly from corresponding DOFs of associated domain.

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.

Note: This primary field will always assume default numbering schemes.

Definition at line 104 of file primaryfield.h.

Constructor & Destructor Documentation

◆ PrimaryField()

oofem::PrimaryField::PrimaryField	(	EngngModel *	a,
		int	idomain,
		FieldType	ft,
		int	nHist )

Constructor. Creates a field of given type associated to given domain. Not using pointer to domain, because this will prevent the use of PrimaryField as an EngngModel attribute. This is because the domain does not exists when PrimaryField is created (this is when EngngModel is created).

Parameters

a	Engineering model which field belongs to.
idomain	Index of domain for field.
ft	Type of stored field.
nHist	Number of old time steps to store.

Definition at line 49 of file primaryfield.C.

References actualStepIndx, actualStepNumber, domainIndx, emodel, oofem::Field::Field(), nHistVectors, prescribedVectors, solStepList, and solutionVectors.

◆ ~PrimaryField()

oofem::PrimaryField::~PrimaryField ( )

virtual

Definition at line 60 of file primaryfield.C.

Member Function Documentation

◆ __evaluateAt() [1/2]

int oofem::PrimaryField::__evaluateAt	(	FloatArray &	answer,
		const FloatArray &	coords,
		ValueModeType	mode,
		TimeStep *	tStep,
		IntArray *	dofId )

virtual

Evaluates the field at given point, allows to select specific dofs using mask.

Parameters

answer	Evaluated field at coords.
coords	Coordinates of the point of interest.
mode	Mode of evaluated unknowns.
tStep	Time step of interest.
dofId	Dof mask, id set to NULL, all Dofs evaluated.

Returns: Error code (0=ok, 1=point not found in domain)

Definition at line 372 of file primaryfield.C.

References oofem::FloatArray::at(), oofem::IntArray::at(), oofem::Element::computeField(), domainIndx, oofem::EIPrimaryFieldInterfaceType, emodel, oofem::IntArray::findFirstIndexOf(), oofem::SpatialLocalizer::giveElementClosestToPoint(), oofem::SpatialLocalizer::giveElementContainingPoint(), oofem::Element::giveElementDofIDMask(), oofem::FEMComponent::giveInterface(), oofem::IntArray::giveSize(), oofem::Domain::giveSpatialLocalizer(), OOFEM_ERROR, oofem::FloatArray::resize(), and oofem::FloatArray::zero().

◆ __evaluateAt() [2/2]

int oofem::PrimaryField::__evaluateAt	(	FloatArray &	answer,
		DofManager *	dman,
		ValueModeType	mode,
		TimeStep *	tStep,
		IntArray *	dofId )

virtual

Evaluates the field at given DOF manager, allows to select specific dofs using mask

Parameters

answer	Evaluated field at dman.
dman	DOF manager of interest.
mode	Mode of evaluated unknowns.
tStep	Time step of interest.
dofId	Dof mask, id set to NULL, all Dofs evaluated.

Returns: Error code (0=ok, 1=point not found in domain).

Definition at line 352 of file primaryfield.C.

References __evaluateAt(), domainIndx, oofem::DofManager::giveCompleteUnknownVector(), oofem::DofManager::giveCoordinates(), oofem::FEMComponent::giveDomain(), and oofem::DofManager::giveUnknownVector().

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

◆ advanceSolution()

void oofem::PrimaryField::advanceSolution ( TimeStep * tStep )

virtual

Brings up a new solution vector for given time step.

Parameters

tStep Time step for new solution vector.

Definition at line 485 of file primaryfield.C.

References actualStepIndx, actualStepNumber, oofem::TimeStep::giveNumber(), givePrescribedVector(), giveSolutionVector(), nHistVectors, OOFEM_ERROR, resolveIndx(), and solStepList.

◆ applyBoundaryCondition() [1/2]

void oofem::PrimaryField::applyBoundaryCondition	(	BoundaryCondition &	bc,
		TimeStep *	tStep )

Applies the boundary condition to all prescribed DOFs in given domain.

Parameters

bc	Boundary condition.
domain	tStep Time step for when bc applies.

Definition at line 289 of file primaryfield.C.

References oofem::FloatArray::at(), oofem::BoundaryCondition::give(), oofem::GeneralBoundaryCondition::giveDofIDs(), oofem::Domain::giveDofManager(), oofem::DofManager::giveDofWithID(), oofem::FEMComponent::giveDomain(), oofem::Dof::giveEqn(), oofem::Set::giveNodeList(), givePrescribedVector(), oofem::Domain::giveSet(), oofem::GeneralBoundaryCondition::giveSetNumber(), oofem::TimeStep::giveTargetTime(), and resolveIndx().

◆ applyBoundaryCondition() [2/2]

void oofem::PrimaryField::applyBoundaryCondition ( TimeStep * tStep )

virtual

Applies all boundary conditions to all prescribed DOFs.

Parameters

tStep Current time step.

Definition at line 265 of file primaryfield.C.

References applyBoundaryCondition(), oofem::FloatArray::at(), domainIndx, emodel, oofem::BoundaryCondition::give(), oofem::Domain::giveBc(), oofem::Domain::giveBcs(), oofem::Domain::giveDofManagers(), givePrescribedVector(), oofem::TimeStep::giveTargetTime(), and resolveIndx().

Referenced by applyBoundaryCondition().

◆ applyDefaultInitialCondition()

void oofem::PrimaryField::applyDefaultInitialCondition ( )

virtual

Applies the default initial values values for all DOFs (0) in given domain.

Parameters

domain Domain number

Definition at line 168 of file primaryfield.C.

References applyInitialCondition(), oofem::FloatArray::at(), domainIndx, emodel, oofem::InitialCondition::give(), oofem::Domain::giveDofManagers(), oofem::Domain::giveIc(), givePrescribedVector(), giveSolutionVector(), oofem::InitialCondition::hasConditionOn(), prescribedVectors, resolveIndx(), and solutionVectors.

◆ applyInitialCondition()

void oofem::PrimaryField::applyInitialCondition ( InitialCondition & ic )

Applies initial condition to all DOFs.

Parameters

ic	Initial condition for DOFs

Definition at line 218 of file primaryfield.C.

References oofem::FloatArray::at(), emodel, oofem::InitialCondition::give(), oofem::DofManager::giveCoordinates(), oofem::Domain::giveDofManager(), oofem::FEMComponent::giveDomain(), oofem::Set::giveNodeList(), givePrescribedVector(), oofem::Domain::giveSet(), oofem::InitialCondition::giveSetNumber(), giveSolutionVector(), oofem::TimeStep::giveTimeIncrement(), oofem::InitialCondition::hasConditionOn(), and resolveIndx().

Referenced by applyDefaultInitialCondition().

◆ evaluateAt() [1/2]

int oofem::PrimaryField::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 429 of file primaryfield.C.

References __evaluateAt().

◆ evaluateAt() [2/2]

int oofem::PrimaryField::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