The class representing scalar error indicator. More...

#include <scalarerrorindicator.h>

Inheritance diagram for oofem::ScalarErrorIndicator:

Collaboration diagram for oofem::ScalarErrorIndicator:

Public Member Functions
	ScalarErrorIndicator (int n, Domain *d)
	Constructor. More...

virtual	~ScalarErrorIndicator ()
	Destructor. More...

virtual double	giveElementError (EE_ErrorType type, Element elem, TimeStep tStep)
	Returns the element error. More...

virtual double	giveValue (EE_ValueType type, TimeStep *tStep)
	Returns the characteristic value of given type. More...

virtual int	estimateError (EE_ErrorMode mode, TimeStep *tStep)
	Estimates the error on associated domain at given time step. More...

virtual RemeshingCriteria *	giveRemeshingCrit ()
	Returns reference to associated remeshing criteria. More...

virtual IRResultType	initializeFrom (InputRecord *ir)
	Initializes receiver according to object description stored in input record. More...

virtual const char *	giveClassName () const

Public Member Functions inherited from oofem::ErrorEstimator
	ErrorEstimator (int n, Domain *d)
	Constructor. More...

virtual	~ErrorEstimator ()
	Destructor. More...

void	setDomain (Domain *d)
	Sets Domain; should also re-initialize attributes if necessary. More...

int	giveNumberOfSkippedElements ()
	Returns number of elements skipped in error estimation. More...

ErrorEstimatorType	giveErrorEstimatorType () const
	Returns error estimation type of receiver. More...

bool	skipRegion (int reg)
	Returns nonzero if region has been skipped in error estimation (user option). More...

virtual void	reinitialize ()

virtual const char *	giveInputRecordName () const

Public Member Functions inherited from oofem::FEMComponent
	FEMComponent (int n, Domain *d)
	Regular constructor, creates component with given number and belonging to given domain. More...

virtual	~FEMComponent ()
	Virtual destructor. More...

Domain *	giveDomain () const

int	giveNumber () const

void	setNumber (int num)
	Sets number of receiver. More...

virtual void	updateLocalNumbering (EntityRenumberingFunctor &f)
	Local renumbering support. More...

virtual void	giveInputRecord (DynamicInputRecord &input)
	Setups the input record string of receiver. More...

virtual contextIOResultType	saveContext (DataStream &stream, ContextMode mode, void *obj=NULL)
	Stores receiver state to output stream. More...

virtual contextIOResultType	restoreContext (DataStream &stream, ContextMode mode, void *obj=NULL)
	Restores the receiver state previously written in stream. More...

virtual int	checkConsistency ()
	Allows programmer to test some internal data, before computation begins. More...

virtual void	printOutputAt (FILE file, TimeStep tStep)
	Prints output of receiver to stream, for given time step. More...

virtual void	printYourself ()
	Prints receiver state on stdout. Useful for debugging. More...

virtual Interface *	giveInterface (InterfaceType t)
	Interface requesting service. More...

std::string	errorInfo (const char *func) const
	Returns string for prepending output (used by error reporting macros). More...

Protected Attributes
int	indicatorType
	Type of internal variable to be indicator (type for temp and nontemp version). More...

InternalStateType	varType
	Corresponding internal state type. More...

Protected Attributes inherited from oofem::ErrorEstimator
ErrorEstimatorType	eeType

std::unique_ptr< RemeshingCriteria >	rc

IntArray	regionSkipMap
	Map indicating regions to skip (region - cross section model). More...

int	skippedNelems
	Number of skipped elements. More...

InternalStateType	IStype
	Internal state type of variable to get internal forces. More...

Protected Attributes inherited from oofem::FEMComponent
int	number
	Component number. More...

Domain *	domain
	Link to domain object, useful for communicating with other FEM components. More...

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

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

inline

Constructor.

Definition at line 65 of file scalarerrorindicator.h.

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

virtual oofem::ScalarErrorIndicator::~ScalarErrorIndicator ( )

inlinevirtual

Destructor.

Definition at line 69 of file scalarerrorindicator.h.

References giveElementError().

Member Function Documentation

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

virtual

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.

Referenced by oofem::CombinedZZSIErrorEstimator::estimateError(), and giveValue().

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

inlinevirtual

Returns: Class name of the receiver.

Implements oofem::FEMComponent.

Definition at line 78 of file scalarerrorindicator.h.

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

virtual

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.

Referenced by oofem::CombinedZZSIErrorEstimator::giveElementError(), and ~ScalarErrorIndicator().

RemeshingCriteria * oofem::ScalarErrorIndicator::giveRemeshingCrit ( )

virtual

Returns reference to associated remeshing criteria.

Implements oofem::ErrorEstimator.

Definition at line 108 of file scalarerrorindicator.C.

References oofem::ErrorEstimator::rc.

Referenced by giveValue(), and initializeFrom().

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

inlinevirtual

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.

References estimateError(), giveRemeshingCrit(), and initializeFrom().

IRResultType oofem::ScalarErrorIndicator::initializeFrom ( InputRecord * ir )

virtual

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.