#include <constantfunction.h>

Inheritance diagram for oofem::ConstantFunction:

Collaboration diagram for oofem::ConstantFunction:

Public Member Functions
	ConstantFunction (int i, Domain *d)
virtual	~ConstantFunction ()
	Destructor.
double	giveValue ()
void	evaluate (FloatArray &answer, const std ::map< std ::string, FunctionArgument > &valDict, GaussPoint *gp=nullptr, double param=0.) override
double	evaluateAtTime (double t) override
double	evaluateVelocityAtTime (double t) override
double	evaluateAccelerationAtTime (double t) override
void	initializeFrom (InputRecord &ir) override
void	giveInputRecord (DynamicInputRecord &input) override
const char *	giveClassName () const override
const char *	giveInputRecordName () const override
void	saveContext (DataStream &stream, ContextMode mode) override
void	restoreContext (DataStream &stream, ContextMode mode) override
Public Member Functions inherited from oofem::Function
	Function (int n, Domain *d)
virtual	~Function ()
	Destructor.
virtual double	evaluate (TimeStep *tStep, ValueModeType mode)
virtual double	evaluate (const std ::map< std ::string, FunctionArgument > &valDict)
double	giveFunctionParameter (int paramID)
void	saveContext (DataStream &stream, ContextMode mode) override
void	restoreContext (DataStream &stream, ContextMode mode) override
Public Member Functions inherited from oofem::FEMComponent
	FEMComponent (int n, Domain *d)
virtual	~FEMComponent ()=default
	Virtual destructor.
Domain *	giveDomain () const
virtual void	setDomain (Domain *d)
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 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).

Private Attributes
double	value
	Value of receiver.

Additional Inherited Members
Public Attributes inherited from oofem::Function
Domain *	funcDomain
int	parameterType
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

Class implementing time function that is constant in time; \( f(t) = C \).

Definition at line 47 of file constantfunction.h.

Constructor & Destructor Documentation

◆ ConstantFunction()

oofem::ConstantFunction::ConstantFunction	(	int	i,
		Domain *	d )

inline

Constructor. Creates constant load time function with given number, belonging to given domain.

Parameters

i	Load time function number.
d	Domain to which new object will belongs.

Definition at line 59 of file constantfunction.h.

References oofem::Function::Function(), and value.

◆ ~ConstantFunction()

virtual oofem::ConstantFunction::~ConstantFunction ( )

inlinevirtual

Destructor.

Definition at line 63 of file constantfunction.h.

Member Function Documentation

◆ evaluate()

void oofem::ConstantFunction::evaluate	(	FloatArray &	answer,
		const std ::map< std ::string, FunctionArgument > &	valDict,
		GaussPoint *	gp = nullptr,
		double	param = 0. )

inlineoverridevirtual

Returns the value of the function for given input.

Parameters

valDict	Map with inputs.
answer	Function value.

Reimplemented from oofem::Function.

Definition at line 68 of file constantfunction.h.

References giveValue().

◆ evaluateAccelerationAtTime()

double oofem::ConstantFunction::evaluateAccelerationAtTime ( double t )

inlineoverridevirtual

Returns the second time derivative of the function at given time.

Parameters

t Time.

Returns: \( f''(t) \).

Implements oofem::Function.

Definition at line 71 of file constantfunction.h.

◆ evaluateAtTime()

double oofem::ConstantFunction::evaluateAtTime ( double t )

inlineoverridevirtual

Returns the value of the function at given time.

Parameters

t Time.

Returns: \( f(t) \).

Reimplemented from oofem::Function.

Definition at line 69 of file constantfunction.h.

References giveValue().

◆ evaluateVelocityAtTime()

double oofem::ConstantFunction::evaluateVelocityAtTime ( double t )

inlineoverridevirtual

Returns the first time derivative of the function at given time.

Parameters

t Time.

Returns: \( f'(t) \).

Implements oofem::Function.

Definition at line 70 of file constantfunction.h.

◆ giveClassName()

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

inlineoverridevirtual

Returns: Class name of the receiver.

Implements oofem::FEMComponent.

Definition at line 76 of file constantfunction.h.

◆ giveInputRecord()

void oofem::ConstantFunction::giveInputRecord ( DynamicInputRecord & input )

overridevirtual

Setups the input record string of receiver.

Parameters

input Dynamic input record to be filled by receiver.

Reimplemented from oofem::FEMComponent.

Definition at line 54 of file constantfunction.C.

References _IFT_ConstantFunction_f, oofem::DynamicInputRecord::setField(), and value.

◆ giveInputRecordName()

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

inlineoverridevirtual

Returns: Input record name of the receiver.

Implements oofem::FEMComponent.

Definition at line 77 of file constantfunction.h.

References _IFT_ConstantFunction_Name.

◆ giveValue()

double oofem::ConstantFunction::giveValue ( )

inline

Returns: Value of receiver.

Definition at line 66 of file constantfunction.h.

References value.

Referenced by evaluate(), and evaluateAtTime().

◆ initializeFrom()

void oofem::ConstantFunction::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::FEMComponent.

Definition at line 45 of file constantfunction.C.

References _IFT_ConstantFunction_f, IR_GIVE_FIELD, and value.

◆ restoreContext()

void oofem::ConstantFunction::restoreContext	(	DataStream &	stream,
		ContextMode	mode )

overridevirtual

Restores the receiver state previously written in stream.

See also: saveContext

Parameters

stream	Input stream.
mode	Determines amount of info available in stream (state, definition, ...).

Exceptions

throws an ContextIOERR exception if error encountered.

Reimplemented from oofem::FEMComponent.

Definition at line 74 of file constantfunction.C.

References oofem::CIO_IOERR, CM_Definition, oofem::DataStream::read(), THROW_CIOERR, and value.

◆ saveContext()

void oofem::ConstantFunction::saveContext	(	DataStream &	stream,
		ContextMode	mode )

overridevirtual

Stores receiver state to output stream.

Parameters

stream	Output stream.
mode	Determines amount of info required in stream (state, definition, ...).

Exceptions

throws an ContextIOERR exception if error encountered.

Reimplemented from oofem::FEMComponent.

Definition at line 61 of file constantfunction.C.

References oofem::CIO_IOERR, CM_Definition, THROW_CIOERR, value, and oofem::DataStream::write().

Member Data Documentation

◆ value

double oofem::ConstantFunction::value

private

Value of receiver.

Definition at line 51 of file constantfunction.h.

Referenced by ConstantFunction(), giveInputRecord(), giveValue(), initializeFrom(), restoreContext(), and saveContext().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConstantFunction()

◆ ~ConstantFunction()

Member Function Documentation

◆ evaluate()

◆ evaluateAccelerationAtTime()

◆ evaluateAtTime()

◆ evaluateVelocityAtTime()

◆ giveClassName()

◆ giveInputRecord()

◆ giveInputRecordName()

◆ giveValue()

◆ initializeFrom()

◆ restoreContext()

◆ saveContext()

Member Data Documentation

◆ value