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

This class implements a function which reads an externally generated field interpolates. More...

#include <interpolatingfunction.h>

+ Inheritance diagram for oofem::InterpolatingFuction:
+ Collaboration diagram for oofem::InterpolatingFuction:

Public Member Functions

 InterpolatingFuction (int n, Domain *d)
 Constructor. More...
 
virtual ~InterpolatingFuction ()
 Destructor. 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 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 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...
 
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 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 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...
 

Protected Attributes

FloatArray field
 
IntArray numberReal
 
- Protected Attributes inherited from oofem::FEMComponent
int number
 Component number. More...
 
Domaindomain
 Link to domain object, useful for communicating with other FEM components. More...
 

Additional Inherited Members

- Public Attributes inherited from oofem::Function
DomainfuncDomain
 
int parameterType
 

Detailed Description

This class implements a function which reads an externally generated field interpolates.

Definition at line 51 of file interpolatingfunction.h.

Constructor & Destructor Documentation

oofem::InterpolatingFuction::InterpolatingFuction ( int  n,
Domain d 
)

Constructor.

Definition at line 46 of file interpolatingfunction.C.

oofem::InterpolatingFuction::~InterpolatingFuction ( )
virtual

Destructor.

Definition at line 49 of file interpolatingfunction.C.

Member Function Documentation

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

Returns the value of the function for given input.

Parameters
valDictMap with inputs.
answerFunction value.

Reimplemented from oofem::Function.

Definition at line 54 of file interpolatingfunction.C.

References oofem::FloatArray::at(), field, numberReal, and OOFEM_ERROR.

virtual double oofem::InterpolatingFuction::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 66 of file interpolatingfunction.h.

double oofem::InterpolatingFuction::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 135 of file interpolatingfunction.C.

References OOFEM_ERROR.

virtual double oofem::InterpolatingFuction::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 65 of file interpolatingfunction.h.

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

Implements oofem::FEMComponent.

Definition at line 69 of file interpolatingfunction.h.

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

Implements oofem::FEMComponent.

Definition at line 70 of file interpolatingfunction.h.

References _IFT_InterpolatingFuction_Name.

IRResultType oofem::InterpolatingFuction::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 144 of file interpolatingfunction.C.

References _IFT_InterpolatingFuction_filename, field, IR_GIVE_FIELD, oofem::IRRT_BAD_FORMAT, oofem::IRRT_OK, numberReal, OOFEM_WARNING, oofem::IntArray::resize(), oofem::FloatArray::resize(), oofem::FloatArray::zero(), and oofem::IntArray::zero().

Member Data Documentation

FloatArray oofem::InterpolatingFuction::field
protected

Definition at line 54 of file interpolatingfunction.h.

Referenced by evaluate(), and initializeFrom().

IntArray oofem::InterpolatingFuction::numberReal
protected

Definition at line 55 of file interpolatingfunction.h.

Referenced by evaluate(), 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