OOFEM  2.4
OOFEM.org - Object Oriented Finite Element Solver
oofem::HeavisideTimeFunction Class Reference

This class implements a Heaviside step load time function. More...

#include <heavisidetimefunction.h>

+ Inheritance diagram for oofem::HeavisideTimeFunction:
+ Collaboration diagram for oofem::HeavisideTimeFunction:

Public Member Functions

 HeavisideTimeFunction (int i, Domain *d)
 
virtual ~HeavisideTimeFunction ()
 
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
 
virtual double evaluateAtTime (double)
 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...
 
- 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 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 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...
 
DomaingiveDomain () 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 InterfacegiveInterface (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 origin
 
double value
 

Additional Inherited Members

- Public Attributes inherited from oofem::Function
DomainfuncDomain
 
int parameterType
 
- Protected Attributes inherited from oofem::FEMComponent
int number
 Component number. More...
 
Domaindomain
 Link to domain object, useful for communicating with other FEM components. More...
 

Detailed Description

This class implements a Heaviside step load time function.

The function is defined by the origin of step and value. The result is value*H(t-origin), where

\[ H(t) = \begin{cases} 0,& t\leq 0 \\ 1, & t>0 \end{cases} \]

Definition at line 59 of file heavisidetimefunction.h.

Constructor & Destructor Documentation

oofem::HeavisideTimeFunction::HeavisideTimeFunction ( int  i,
Domain d 
)
inline

Definition at line 65 of file heavisidetimefunction.h.

virtual oofem::HeavisideTimeFunction::~HeavisideTimeFunction ( )
inlinevirtual

Definition at line 69 of file heavisidetimefunction.h.

Member Function Documentation

virtual double oofem::HeavisideTimeFunction::evaluateAccelerationAtTime ( double  t)
inlinevirtual

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

Parameters
tTime.
Returns
$ f''(t) $.

Implements oofem::Function.

Definition at line 78 of file heavisidetimefunction.h.

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

Returns the value of the function at given time.

Parameters
tTime.
Returns
$ f(t) $.

Reimplemented from oofem::Function.

Definition at line 43 of file heavisidetimefunction.C.

References origin, and value.

virtual double oofem::HeavisideTimeFunction::evaluateVelocityAtTime ( double  t)
inlinevirtual

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

Parameters
tTime.
Returns
$ f'(t) $.

Implements oofem::Function.

Definition at line 77 of file heavisidetimefunction.h.

virtual const char* oofem::HeavisideTimeFunction::giveClassName ( ) const
inlinevirtual
Returns
Class name of the receiver.

Implements oofem::FEMComponent.

Definition at line 73 of file heavisidetimefunction.h.

void oofem::HeavisideTimeFunction::giveInputRecord ( DynamicInputRecord input)
virtual

Setups the input record string of receiver.

Parameters
inputDynamic input record to be filled by receiver.

Reimplemented from oofem::FEMComponent.

Definition at line 66 of file heavisidetimefunction.C.

References _IFT_HeavisideTimeFunction_origin, _IFT_HeavisideTimeFunction_value, oofem::FEMComponent::giveInputRecord(), origin, oofem::DynamicInputRecord::setField(), and value.

virtual const char* oofem::HeavisideTimeFunction::giveInputRecordName ( ) const
inlinevirtual
Returns
Input record name of the receiver.

Implements oofem::FEMComponent.

Definition at line 74 of file heavisidetimefunction.h.

References _IFT_HeavisideTimeFunction_Name.

IRResultType oofem::HeavisideTimeFunction::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
irInput record to initialize from.
Returns
IRResultType

Reimplemented from oofem::FEMComponent.

Definition at line 55 of file heavisidetimefunction.C.

References _IFT_HeavisideTimeFunction_origin, _IFT_HeavisideTimeFunction_value, oofem::FEMComponent::initializeFrom(), IR_GIVE_FIELD, origin, and value.

Member Data Documentation

double oofem::HeavisideTimeFunction::origin
private

Definition at line 62 of file heavisidetimefunction.h.

Referenced by evaluateAtTime(), giveInputRecord(), and initializeFrom().

double oofem::HeavisideTimeFunction::value
private

Definition at line 62 of file heavisidetimefunction.h.

Referenced by evaluateAtTime(), giveInputRecord(), and initializeFrom().


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

This page is part of the OOFEM documentation. Copyright (c) 2011 Borek Patzak
Project e-mail: info@oofem.org
Generated at Tue Jan 2 2018 20:07:36 for OOFEM by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2011