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

This class implements a transport material status information. More...

#include <transportmaterial.h>

+ Inheritance diagram for oofem::TransportMaterialStatus:
+ Collaboration diagram for oofem::TransportMaterialStatus:

Public Member Functions

 TransportMaterialStatus (int n, Domain *d, GaussPoint *g)
 Constructor - creates new TransportMaterialStatus with number n, belonging to domain d and IntegrationPoint g. More...
 
virtual ~TransportMaterialStatus ()
 Destructor. More...
 
virtual void printOutputAt (FILE *file, TimeStep *tStep)
 Print receiver's output to given stream. More...
 
virtual void initTempStatus ()
 Initializes the temporary internal variables, describing the current state according to previously reached equilibrium internal variables. More...
 
virtual void updateYourself (TimeStep *tStep)
 Update equilibrium history variables according to temp-variables. 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...
 
void letTempStateVectorBe (FloatArray v)
 
virtual const char * giveClassName () const
 
void setTempGradient (FloatArray grad)
 Set gradient. More...
 
void setTempField (FloatArray newField)
 Set field. More...
 
void setTempFlux (FloatArray w)
 Set flux. More...
 
const FloatArraygiveGradient ()
 Return last gradient. More...
 
const FloatArraygiveField ()
 Return last field. More...
 
const FloatArraygiveFlux ()
 Returns last flux. More...
 
const FloatArraygiveTempGradient ()
 Return last gradient. More...
 
const FloatArraygiveTempField ()
 Return last field. More...
 
const FloatArraygiveTempFlux ()
 Returns last flux. More...
 
double giveMaturity ()
 Returns maturity. More...
 
- Public Member Functions inherited from oofem::MaterialStatus
 MaterialStatus (int n, Domain *d, GaussPoint *g)
 Constructor. More...
 
virtual ~MaterialStatus ()
 Destructor. More...
 
virtual bool giveMaterialProperty (int propID, double &value)
 Returns the value of material model property stored in receiving status. More...
 
virtual void setMaterialProperty (int propID, double value)
 Allows to set the value of material model property to be stored in receiving status. More...
 
virtual void setStatusVariable (int varID, double value)
 Allows to set the value of a specific variable, identified by varID. More...
 
virtual void restoreConsistency ()
 Restores consistency of the status, i.e., computes or corrects the values of certain status variables such that the state is admissible. More...
 
virtual IRResultType initializeFrom (InputRecord *ir)
 Initializes receiver according to object description stored in input record. More...
 
- Public Member Functions inherited from oofem::IntegrationPointStatus
 IntegrationPointStatus (int n, Domain *d, GaussPoint *g)
 Constructor. More...
 
virtual ~IntegrationPointStatus ()
 Destructor. More...
 
virtual const char * giveInputRecordName () const
 
- 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 int checkConsistency ()
 Allows programmer to test some internal data, before computation begins. 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 temp_field
 Vector containing the last used field. More...
 
FloatArray temp_gradient
 Vector containing the last used gradient. More...
 
FloatArray temp_flux
 Vector containing the last computed flux. More...
 
FloatArray field
 Vector containing the last equilibrated field. The physical meaning corresponds to temperature, concentration etc. More...
 
FloatArray gradient
 Vector containing the last equilibrated gradient. It is the spatial gradient of the field. More...
 
FloatArray flux
 Vector containing the last equilibrated flux. The physical meaning corresponds to energy flux, mass flow, etc. More...
 
double maturity
 A scalar containing maturity (integration of temperature over time) More...
 
- Protected Attributes inherited from oofem::IntegrationPointStatus
GaussPointgp
 Associated integration point. More...
 
- 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 transport material status information.

When needed, new materials should specialized a derived class from this base. It is attribute of a Gauss point.

See also
MaterialStatus For general description of material status, and its role.

Definition at line 53 of file transportmaterial.h.

Constructor & Destructor Documentation

oofem::TransportMaterialStatus::TransportMaterialStatus ( int  n,
Domain d,
GaussPoint g 
)

Constructor - creates new TransportMaterialStatus with number n, belonging to domain d and IntegrationPoint g.

Definition at line 68 of file transportmaterial.C.

Referenced by oofem::TransportMaterial::CreateStatus().

virtual oofem::TransportMaterialStatus::~TransportMaterialStatus ( )
inlinevirtual

Destructor.

Definition at line 71 of file transportmaterial.h.

References initTempStatus(), printOutputAt(), restoreContext(), saveContext(), and updateYourself().

Member Function Documentation

virtual const char* oofem::TransportMaterialStatus::giveClassName ( ) const
inlinevirtual
const FloatArray& oofem::TransportMaterialStatus::giveFlux ( )
inline
const FloatArray& oofem::TransportMaterialStatus::giveGradient ( )
inline
double oofem::TransportMaterialStatus::giveMaturity ( )
inline

Returns maturity.

Definition at line 108 of file transportmaterial.h.

References maturity.

Referenced by oofem::TransportMaterial::giveIPValue().

const FloatArray& oofem::TransportMaterialStatus::giveTempFlux ( )
inline

Returns last flux.

Definition at line 106 of file transportmaterial.h.

References temp_flux.

const FloatArray& oofem::TransportMaterialStatus::giveTempGradient ( )
inline

Return last gradient.

Definition at line 102 of file transportmaterial.h.

References temp_gradient.

Referenced by oofem::NonlinearMassTransferMaterial::giveCharacteristicMatrix().

void oofem::TransportMaterialStatus::initTempStatus ( )
virtual

Initializes the temporary internal variables, describing the current state according to previously reached equilibrium internal variables.

Reimplemented from oofem::MaterialStatus.

Reimplemented in oofem::LatticeTransportMaterialStatus, and oofem::RVEStokesFlowMaterialStatus.

Definition at line 109 of file transportmaterial.C.

References field, flux, gradient, oofem::MaterialStatus::initTempStatus(), temp_field, temp_flux, and temp_gradient.

Referenced by oofem::RVEStokesFlowMaterialStatus::initTempStatus(), oofem::LatticeTransportMaterialStatus::initTempStatus(), and ~TransportMaterialStatus().

void oofem::TransportMaterialStatus::letTempStateVectorBe ( FloatArray  v)
inline
Todo:
REMOVE THESE: Assigns temporary state vector from a given vector v.

Definition at line 83 of file transportmaterial.h.

Referenced by oofem::HydratingHeMoMaterial::updateInternalState(), oofem::HydratingIsoHeatMaterial::updateInternalState(), and oofem::TransportMaterial::updateInternalState().

contextIOResultType oofem::TransportMaterialStatus::restoreContext ( DataStream stream,
ContextMode  mode,
void *  obj = NULL 
)
virtual

Restores the receiver state previously written in stream.

See also
saveContext
Parameters
streamInput stream.
modeDetermines amount of info available in stream (state, definition, ...).
objSpecial parameter for sending extra information.
Returns
contextIOResultType.
Exceptions
throwsan ContextIOERR exception if error encountered.

Reimplemented from oofem::FEMComponent.

Reimplemented in oofem::RVEStokesFlowMaterialStatus.

Definition at line 150 of file transportmaterial.C.

References oofem::CIO_OK, field, flux, gradient, oofem::FEMComponent::restoreContext(), oofem::FloatArray::restoreYourself(), and THROW_CIOERR.

Referenced by oofem::RVEStokesFlowMaterialStatus::restoreContext(), and ~TransportMaterialStatus().

contextIOResultType oofem::TransportMaterialStatus::saveContext ( DataStream stream,
ContextMode  mode,
void *  obj = NULL 
)
virtual

Stores receiver state to output stream.

Parameters
streamOutput stream.
modeDetermines amount of info required in stream (state, definition, ...).
objSpecial parameter, used only to send particular integration point to material class version of this method.
Returns
contextIOResultType.
Exceptions
throwsan ContextIOERR exception if error encountered.

Reimplemented from oofem::FEMComponent.

Reimplemented in oofem::RVEStokesFlowMaterialStatus.

Definition at line 122 of file transportmaterial.C.

References oofem::CIO_OK, field, flux, gradient, oofem::FEMComponent::saveContext(), oofem::FloatArray::storeYourself(), and THROW_CIOERR.

Referenced by oofem::RVEStokesFlowMaterialStatus::saveContext(), and ~TransportMaterialStatus().

Member Data Documentation

FloatArray oofem::TransportMaterialStatus::field
protected
FloatArray oofem::TransportMaterialStatus::flux
protected

Vector containing the last equilibrated flux. The physical meaning corresponds to energy flux, mass flow, etc.

Definition at line 62 of file transportmaterial.h.

Referenced by giveFlux(), initTempStatus(), restoreContext(), saveContext(), and updateYourself().

FloatArray oofem::TransportMaterialStatus::gradient
protected

Vector containing the last equilibrated gradient. It is the spatial gradient of the field.

Definition at line 61 of file transportmaterial.h.

Referenced by giveGradient(), initTempStatus(), restoreContext(), saveContext(), and updateYourself().

double oofem::TransportMaterialStatus::maturity
protected

A scalar containing maturity (integration of temperature over time)

Definition at line 65 of file transportmaterial.h.

Referenced by giveMaturity(), and oofem::HydratingConcreteMatStatus::updateYourself().

FloatArray oofem::TransportMaterialStatus::temp_field
protected

Vector containing the last used field.

Definition at line 56 of file transportmaterial.h.

Referenced by giveTempField(), initTempStatus(), setTempField(), and updateYourself().

FloatArray oofem::TransportMaterialStatus::temp_flux
protected

Vector containing the last computed flux.

Definition at line 58 of file transportmaterial.h.

Referenced by giveTempFlux(), initTempStatus(), setTempFlux(), and updateYourself().

FloatArray oofem::TransportMaterialStatus::temp_gradient
protected

Vector containing the last used gradient.

Definition at line 57 of file transportmaterial.h.

Referenced by giveTempGradient(), initTempStatus(), setTempGradient(), and updateYourself().


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:43 for OOFEM by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2011