#include <scalarerrorindicator.h>

Inheritance diagram for oofem::ScalarErrorIndicator:

Collaboration diagram for oofem::ScalarErrorIndicator:

Public Member Functions
	ScalarErrorIndicator (int n, Domain *d)
	Constructor.
virtual	~ScalarErrorIndicator ()
	Destructor.
double	giveElementError (EE_ErrorType type, Element elem, TimeStep tStep) override
double	giveValue (EE_ValueType type, TimeStep *tStep) override
int	estimateError (EE_ErrorMode mode, TimeStep *tStep) override
RemeshingCriteria *	giveRemeshingCrit () override
void	initializeFrom (InputRecord &ir) override
const char *	giveClassName () const override
const char *	giveInputRecordName () const override
Public Member Functions inherited from oofem::ErrorEstimator
	ErrorEstimator (int n, Domain *d)
	Constructor.
virtual	~ErrorEstimator ()
	Destructor.
void	setDomain (Domain *d) override
	Sets Domain; should also re-initialize attributes if necessary.
int	giveNumberOfSkippedElements ()
ErrorEstimatorType	giveErrorEstimatorType () const
bool	skipRegion (int reg)
virtual void	reinitialize ()
Public Member Functions inherited from oofem::FEMComponent
	FEMComponent (int n, Domain *d)
virtual	~FEMComponent ()=default
	Virtual destructor.
Domain *	giveDomain () const
int	giveNumber () const
void	setNumber (int num)
virtual void	updateLocalNumbering (EntityRenumberingFunctor &f)
virtual void	initializeFrom (InputRecord &ir, int priority)
virtual void	initializeFinish ()
virtual void	postInitialize ()
	Performs post initialization steps. Called after all components are created and initialized.
virtual void	giveInputRecord (DynamicInputRecord &input)
virtual void	saveContext (DataStream &stream, ContextMode mode)
virtual void	restoreContext (DataStream &stream, ContextMode mode)
virtual int	checkConsistency ()
virtual void	printOutputAt (FILE file, TimeStep tStep)
virtual void	printYourself ()
	Prints receiver state on stdout. Useful for debugging.
virtual Interface *	giveInterface (InterfaceType t)
std::string	errorInfo (const char *func) const
	Returns string for prepending output (used by error reporting macros).

Protected Attributes
int	indicatorType
	Type of internal variable to be indicator (type for temp and nontemp version).
InternalStateType	varType
	Corresponding internal state type.
Protected Attributes inherited from oofem::ErrorEstimator
ErrorEstimatorType	eeType
std ::unique_ptr< RemeshingCriteria >	rc
IntArray	regionSkipMap
int	skippedNelems
	Number of skipped elements.
InternalStateType	IStype
	Internal state type of variable to get internal forces.
Protected Attributes inherited from oofem::FEMComponent
int	number
	Component number.
Domain *	domain
	Link to domain object, useful for communicating with other FEM components.

Detailed Description

The class representing scalar error indicator. It indicates element error based on the value of some suitable scalar value obtained from the element integration points and corresponding material model.

Definition at line 55 of file scalarerrorindicator.h.

Constructor & Destructor Documentation

◆ ScalarErrorIndicator()

oofem::ScalarErrorIndicator::ScalarErrorIndicator	(	int	n,
		Domain *	d )

inline

Constructor.

Definition at line 65 of file scalarerrorindicator.h.

References oofem::EET_SEI, oofem::ErrorEstimator::eeType, and oofem::ErrorEstimator::ErrorEstimator().

◆ ~ScalarErrorIndicator()

virtual oofem::ScalarErrorIndicator::~ScalarErrorIndicator ( )

inlinevirtual

Destructor.

Definition at line 69 of file scalarerrorindicator.h.

Member Function Documentation

◆ estimateError()

int oofem::ScalarErrorIndicator::estimateError	(	EE_ErrorMode	mode,
		TimeStep *	tStep )

overridevirtual

Estimates the error on associated domain at given time step. The estimated values can be requested using giveElementError and giveValue methods. The type of errors provided depends on error estimator type implementing the service.

Parameters

mode	Error mode.
tStep	Time step.

Implements oofem::ErrorEstimator.

Definition at line 48 of file scalarerrorindicator.C.

References oofem::equilibratedEM, indicatorType, and varType.

◆ giveClassName()

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

inlineoverridevirtual

Returns: Class name of the receiver.

Implements oofem::FEMComponent.

Definition at line 78 of file scalarerrorindicator.h.

◆ giveElementError()

double oofem::ScalarErrorIndicator::giveElementError	(	EE_ErrorType	type,
		Element *	elem,
		TimeStep *	tStep )

overridevirtual

Returns the element error. The estimateError service should be called before.

Parameters

type	Error type.
elem	Element for which error requested.
tStep	Time step.

Returns: Element error.

Implements oofem::ErrorEstimator.

Definition at line 62 of file scalarerrorindicator.C.

References oofem::FloatArray::computeNorm(), oofem::Element::giveDefaultIntegrationRulePtr(), oofem::Element::giveIPValue(), oofem::Element::giveRegionNumber(), oofem::indicatorET, oofem::max(), oofem::ErrorEstimator::skipRegion(), and varType.

◆ giveInputRecordName()

const char * oofem::ScalarErrorIndicator::giveInputRecordName ( ) const

inlineoverridevirtual

Returns: Input record name of the receiver.

Implements oofem::FEMComponent.

Definition at line 79 of file scalarerrorindicator.h.

References _IFT_ScalarErrorIndicator_Name.

◆ giveRemeshingCrit()

RemeshingCriteria * oofem::ScalarErrorIndicator::giveRemeshingCrit ( )

overridevirtual

Returns reference to associated remeshing criteria.

Implements oofem::ErrorEstimator.

Definition at line 106 of file scalarerrorindicator.C.

References oofem::ErrorEstimator::rc.

Referenced by initializeFrom().

◆ giveValue()

double oofem::ScalarErrorIndicator::giveValue	(	EE_ValueType	type,
		TimeStep *	tStep )

inlineoverridevirtual

Returns the characteristic value of given type. The estimateError service should be called before. This method is supposed to be used by associated remeshingCriteria to access some characteristic values already computed or known at error estimator level.

Parameters

type	Error type.
tStep	Time step.

Returns: Error value for given type.

Implements oofem::ErrorEstimator.

Definition at line 72 of file scalarerrorindicator.h.

◆ initializeFrom()

void oofem::ScalarErrorIndicator::initializeFrom ( InputRecord & ir )

overridevirtual

Initializes receiver according to object description stored in input record. This function is called immediately after creating object using constructor. Input record can be imagined as data record in component database belonging to receiver. Receiver may use value-name extracting functions to extract particular field from record. Note that initializeFrom may be called mutiple times.

See also: IR_GIVE_FIELD; IR_GIVE_OPTIONAL_FIELD

Parameters

ir	Input record to initialize from.
priority	Priority of the input record. This is used to determine the order of initialization

Reimplemented from oofem::ErrorEstimator.

Definition at line 93 of file scalarerrorindicator.C.

References _IFT_ScalarErrorIndicator_vartype, giveRemeshingCrit(), indicatorType, IR_GIVE_FIELD, and OOFEM_ERROR.

Member Data Documentation

◆ indicatorType

int oofem::ScalarErrorIndicator::indicatorType

protected

Type of internal variable to be indicator (type for temp and nontemp version).

Definition at line 59 of file scalarerrorindicator.h.

Referenced by estimateError(), and initializeFrom().

◆ varType

InternalStateType oofem::ScalarErrorIndicator::varType

protected

Corresponding internal state type.

Definition at line 61 of file scalarerrorindicator.h.

Referenced by estimateError(), and giveElementError().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ScalarErrorIndicator()

◆ ~ScalarErrorIndicator()

Member Function Documentation

◆ estimateError()

◆ giveClassName()

◆ giveElementError()

◆ giveInputRecordName()

◆ giveRemeshingCrit()

◆ giveValue()

◆ initializeFrom()

Member Data Documentation

◆ indicatorType

◆ varType