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

Class representing foreign temperature field, which asks a field object to return temperature at given point. More...

#include <foreigntempfieldload.h>

+ Inheritance diagram for oofem::ForeignTemperatureFieldLoad:
+ Collaboration diagram for oofem::ForeignTemperatureFieldLoad:

Public Member Functions

 ForeignTemperatureFieldLoad (int n, Domain *d)
 Constructor. More...
virtual ~ForeignTemperatureFieldLoad ()
 Destructor. More...
virtual void computeValueAt (FloatArray &answer, TimeStep *tStep, const FloatArray &coords, ValueModeType mode)
 Computes components values of temperature field at given point (coordinates given in Global c.s.). More...
virtual const char * giveInputRecordName () const
virtual const char * giveClassName () const
virtual IRResultType initializeFrom (InputRecord *ir)
 Initializes receiver according to object description stored in input record. More...
- Public Member Functions inherited from oofem::StructuralTemperatureLoad
 StructuralTemperatureLoad (int n, Domain *d)
virtual bcValType giveBCValType () const
 Returns receiver load type. More...
virtual bcGeomType giveBCGeoType () const
 Returns geometry character of boundary condition. More...
- Public Member Functions inherited from oofem::Load
 Load (int n, Domain *d)
 Constructor. More...
virtual ~Load ()
 Destructor. More...
virtual void computeComponentArrayAt (FloatArray &answer, TimeStep *tStep, ValueModeType mode)
 Computes boundary condition value - its components values at given time. More...
virtual void computeValues (FloatArray &answer, TimeStep *tStep, const FloatArray &coords, const IntArray &dofids, ValueModeType mode)
 Computes components values for specified dof ids. More...
int isDofExcluded (int index)
 Returns the value of dofExcludeMask corresponding to given index. More...
virtual void scale (double s)
 Scales the receiver according to given value. More...
virtual CoordSystType giveCoordSystMode ()
 Returns receiver's coordinate system. More...
virtual FormulationType giveFormulationType ()
 Specifies is load should take local or global coordinates. More...
virtual int giveApproxOrder ()
virtual double giveProperty (int aProperty, TimeStep *tStep)
 Returns the value of a property 'aProperty'. More...
virtual void giveInputRecord (DynamicInputRecord &input)
 Setups the input record string of receiver. More...
const FloatArraygiveComponentArray () const
void setComponentArray (FloatArray &arry)
- Public Member Functions inherited from oofem::GeneralBoundaryCondition
 GeneralBoundaryCondition (int n, Domain *d)
 Constructor. More...
virtual ~GeneralBoundaryCondition ()
 Destructor. More...
int giveSetNumber ()
 Gives the set number which boundary condition is applied to. More...
virtual int giveNumberOfInternalDofManagers ()
 Gives the number of internal dof managers. More...
virtual DofManagergiveInternalDofManager (int i)
 Gives an internal dof manager from receiver. More...
FunctiongiveTimeFunction ()
virtual bool isImposed (TimeStep *tStep)
 Returns nonzero if receiver representing BC is imposed at given time, otherwise returns zero. More...
virtual const IntArraygiveDofIDs () const
 Array with default dofs which b.c. More...
virtual bcType giveType () const
virtual void postInitialize ()
 Performs post initialization steps. 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...
- 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 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...

Public Attributes

std::shared_ptr< FieldforeignField
- Public Attributes inherited from oofem::Load
bool reference

Additional Inherited Members

- Public Types inherited from oofem::Load
enum  CoordSystType { CST_Global, CST_Local, CST_UpdatedGlobal }
 Load coordinate system type. More...
enum  FormulationType { FT_Entity, FT_Global }
 Type determining the type of formulation (entity local or global one). More...
- Protected Attributes inherited from oofem::Load
FloatArray componentArray
 Components of boundary condition. More...
IntArray dofExcludeMask
 The load is specified for all dofs of object to which is associated. More...
- Protected Attributes inherited from oofem::GeneralBoundaryCondition
int timeFunction
 Associated load time function. More...
bcValType valType
 Physical meaning of BC value. More...
IntArray dofs
 Dofs that b.c. is applied to (relevant for Dirichlet type b.c.s). More...
int isImposedTimeFunction
 Zero by default - the BC is than always imposed. More...
int set
 Set number for boundary condition to be applied to. More...
- Protected Attributes inherited from oofem::FEMComponent
int number
 Component number. More...
 Link to domain object, useful for communicating with other FEM components. More...

Detailed Description

Class representing foreign temperature field, which asks a field object to return temperature at given point.

The load time function is not used here, the field has to be updated by the user if it is non-constant in time.

The field (stored in foreignField) cannot be set in the input file (there is only one mesh defined), it is typically assigned using Python bindings.

Definition at line 60 of file foreigntempfieldload.h.

Constructor & Destructor Documentation

oofem::ForeignTemperatureFieldLoad::ForeignTemperatureFieldLoad ( int  n,
Domain d 


Creates temperature load function with given number, belonging to given domain.

nLoad time function number
dDomain to which new object will belongs.

Definition at line 71 of file foreigntempfieldload.h.

virtual oofem::ForeignTemperatureFieldLoad::~ForeignTemperatureFieldLoad ( )


Definition at line 73 of file foreigntempfieldload.h.

References computeValueAt().

Member Function Documentation

void oofem::ForeignTemperatureFieldLoad::computeValueAt ( FloatArray answer,
TimeStep tStep,
const FloatArray coords,
ValueModeType  mode 

Computes components values of temperature field at given point (coordinates given in Global c.s.).

taking into account corresponding load time function value respecting load response mode.

answerComponent values at given point and time.
tStepTime step representing time.
coordsGlobal coordinates, which are used to evaluate components values.
modeDetermines response mode.

Reimplemented from oofem::StructuralTemperatureLoad.

Definition at line 44 of file foreigntempfieldload.C.

References oofem::__ValueModeTypeToString(), foreignField, and OOFEM_ERROR.

Referenced by ~ForeignTemperatureFieldLoad().

virtual const char* oofem::ForeignTemperatureFieldLoad::giveClassName ( ) const
Class name of the receiver.

Reimplemented from oofem::StructuralTemperatureLoad.

Definition at line 86 of file foreigntempfieldload.h.

References initializeFrom().

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

Reimplemented from oofem::StructuralTemperatureLoad.

Definition at line 85 of file foreigntempfieldload.h.

References _IFT_ForeignTemperatureFieldLoad_Name.

IRResultType oofem::ForeignTemperatureFieldLoad::initializeFrom ( InputRecord ir)

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
irInput record to initialize from.

Reimplemented from oofem::Load.

Definition at line 60 of file foreigntempfieldload.C.

References oofem::IRRT_OK.

Referenced by giveClassName().

Member Data Documentation

std::shared_ptr<Field> oofem::ForeignTemperatureFieldLoad::foreignField

Definition at line 65 of file foreigntempfieldload.h.

Referenced by computeValueAt().

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