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

#include <constantfunction.h>

Inheritance diagram for oofem::ConstantFunction:

Collaboration diagram for oofem::ConstantFunction:

Public Member Functions
	ConstantFunction (int i, Domain *d)
	Constructor. More...

virtual	~ConstantFunction ()
	Destructor. More...

double	giveValue ()

virtual void	evaluate (FloatArray &answer, const std::map< std::string, FunctionArgument > &valDict, GaussPoint *gp=NULL, double param=0.)
	Returns the value of the function for given input. More...

virtual double	evaluateAtTime (double t)
	Returns the value of the function at given time. More...

virtual double	evaluateVelocityAtTime (double t)
	Returns the first time derivative of the function at given time. More...

virtual double	evaluateAccelerationAtTime (double t)
	Returns the second time derivative of the function at given time. More...

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

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

virtual const char *	giveClassName () const

virtual const char *	giveInputRecordName () const

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

virtual	~Function ()
	Destructor. More...

double	evaluate (TimeStep *tStep, ValueModeType mode)
	Returns the value of load time function at given time. More...

virtual double	evaluate (const std::map< std::string, FunctionArgument > &valDict)
	Returns the (scalar) value of the function for given input. More...

double	giveFunctionParameter (int paramID)

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

virtual void	setDomain (Domain *d)
	Sets associated Domain. More...

int	giveNumber () const

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

virtual void	updateLocalNumbering (EntityRenumberingFunctor &f)
	Local renumbering support. 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...

Private Attributes
double	value
	Value of receiver. More...

Additional Inherited Members
Public Attributes inherited from oofem::Function
Domain *	funcDomain

int	parameterType

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

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

Definition at line 47 of file constantfunction.h.

Constructor & Destructor Documentation

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.

virtual oofem::ConstantFunction::~ConstantFunction ( )

inlinevirtual

Destructor.

Definition at line 63 of file constantfunction.h.

Member Function Documentation

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

inlinevirtual

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.

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

inlinevirtual

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

Parameters

t Time.

Returns: .

Implements oofem::Function.

Definition at line 71 of file constantfunction.h.

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

inlinevirtual

Returns the value of the function at given time.

Parameters

t Time.

Returns: .

Reimplemented from oofem::Function.

Definition at line 69 of file constantfunction.h.

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

inlinevirtual

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

Parameters

t Time.

Returns: .

Implements oofem::Function.

Definition at line 70 of file constantfunction.h.

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

inlinevirtual

Returns: Class name of the receiver.

Implements oofem::FEMComponent.

Definition at line 76 of file constantfunction.h.

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

virtual

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::FEMComponent::giveInputRecord(), oofem::DynamicInputRecord::setField(), and value.

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

inlinevirtual

Returns: Input record name of the receiver.

Implements oofem::FEMComponent.

Definition at line 77 of file constantfunction.h.

References _IFT_ConstantFunction_Name.

double oofem::ConstantFunction::giveValue ( )

inline

Returns: Value of receiver.

Definition at line 66 of file constantfunction.h.

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

See also: IR_GIVE_FIELD; IR_GIVE_OPTIONAL_FIELD

Parameters

ir	Input record to initialize from.

Returns: IRResultType

Reimplemented from oofem::FEMComponent.

Definition at line 43 of file constantfunction.C.

References _IFT_ConstantFunction_f, oofem::FEMComponent::initializeFrom(), IR_GIVE_FIELD, and value.

Member Data Documentation

double oofem::ConstantFunction::value

private

Value of receiver.

Definition at line 51 of file constantfunction.h.

Referenced by giveInputRecord(), and initializeFrom().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation