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

This class implements a transport constitutive model for saturated and unsaturated porous materials for lattice elements. More...

#include <latticetransmat.h>

+ Inheritance diagram for oofem::LatticeTransportMaterial:
+ Collaboration diagram for oofem::LatticeTransportMaterial:

Public Member Functions

 LatticeTransportMaterial (int n, Domain *d)
 
virtual ~LatticeTransportMaterial ()
 
virtual void giveFluxVector (FloatArray &answer, GaussPoint *gp, const FloatArray &grad, const FloatArray &field, TimeStep *tStep)
 Returns the flux for the field and its gradient. More...
 
virtual void giveCharacteristicMatrix (FloatMatrix &answer, MatResponseMode mode, GaussPoint *gp, TimeStep *tStep)
 Computes characteristic matrix of receiver in given integration point. More...
 
virtual double giveCharacteristicValue (MatResponseMode mode, GaussPoint *gp, TimeStep *tStep)
 Computes the characteristic value of receiver in given integration point, respecting its history. More...
 
double computeConductivity (double suction, GaussPoint *gp, TimeStep *tStep)
 Computes the conductivity. More...
 
double computeCapacity (double suction, GaussPoint *gp)
 Computes the capacity. More...
 
double computeMass (FloatArray &stateVector, GaussPoint *gp)
 Computes the mass. 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...
 
virtual double give (int, GaussPoint *gp)
 Returns the value of material property 'aProperty'. More...
 
virtual MaterialStatusCreateStatus (GaussPoint *gp) const
 Creates new copy of associated status and inserts it into given integration point. More...
 
- Public Member Functions inherited from oofem::TransportMaterial
 TransportMaterial (int n, Domain *d)
 Constructor. More...
 
virtual ~TransportMaterial ()
 Destructor. More...
 
virtual void updateInternalState (const FloatArray &state, GaussPoint *gp, TimeStep *tStep)
 Updates internal state of material according to new state vector. More...
 
virtual int hasInternalSource ()
 Returns nonzero if receiver generates internal source of state variable(s), zero otherwise. More...
 
virtual void computeInternalSourceVector (FloatArray &val, GaussPoint *gp, TimeStep *tStep, ValueModeType mode)
 Computes the internal source vector of receiver. More...
 
virtual double giveHumidity (GaussPoint *gp, ValueModeType mode)
 Returns positive value of humidity if implemented and enabled in derived material, -1 otherwise. More...
 
virtual int giveIPValue (FloatArray &answer, GaussPoint *gp, InternalStateType type, TimeStep *tStep)
 Returns the integration point corresponding value in Reduced form. More...
 
- Public Member Functions inherited from oofem::Material
 Material (int n, Domain *d)
 Constructor. More...
 
virtual ~Material ()
 Destructor. More...
 
virtual bool isCharacteristicMtrxSymmetric (MatResponseMode rMode)
 Returns true if stiffness matrix of receiver is symmetric Default implementation returns true. More...
 
virtual bool hasProperty (int aProperty, GaussPoint *gp)
 Returns true if 'aProperty' exists on material. More...
 
virtual void modifyProperty (int aProperty, double value, GaussPoint *gp)
 Modify 'aProperty', which already exists on material. More...
 
double giveCastingTime ()
 
virtual bool isActivated (TimeStep *tStep)
 
virtual int hasNonLinearBehaviour ()
 Returns nonzero if receiver is non linear. More...
 
virtual int hasMaterialModeCapability (MaterialMode mode)
 Tests if material supports material mode. More...
 
virtual int hasCastingTimeSupport ()
 Tests if material supports casting time. More...
 
virtual void giveInputRecord (DynamicInputRecord &input)
 Setups the input record string of receiver. More...
 
virtual void printYourself ()
 Prints receiver state on stdout. Useful for debugging. More...
 
virtual contextIOResultType saveIPContext (DataStream &stream, ContextMode mode, GaussPoint *gp)
 Stores integration point state to output stream. More...
 
virtual contextIOResultType restoreIPContext (DataStream &stream, ContextMode mode, GaussPoint *gp)
 Reads integration point state to output stream. More...
 
virtual int checkConsistency ()
 Allows programmer to test some internal data, before computation begins. More...
 
virtual int initMaterial (Element *element)
 Optional function to call specific procedures when initializing a material. More...
 
virtual MaterialStatusgiveStatus (GaussPoint *gp) const
 Returns material status of receiver in given integration point. More...
 
virtual int packUnknowns (DataStream &buff, TimeStep *tStep, GaussPoint *ip)
 Pack all necessary data of integration point (according to element parallel_mode) into given communication buffer. More...
 
virtual int unpackAndUpdateUnknowns (DataStream &buff, TimeStep *tStep, GaussPoint *ip)
 Unpack and updates all necessary data of given integration point (according to element parallel_mode) into given communication buffer. More...
 
virtual int estimatePackSize (DataStream &buff, GaussPoint *ip)
 Estimates the necessary pack size to hold all packed data of receiver. More...
 
virtual double predictRelativeComputationalCost (GaussPoint *gp)
 Returns the weight representing relative computational cost of receiver The reference material model is linear isotropic material - its weight is set to 1.0 The other material models should compare to this reference model. More...
 
virtual double predictRelativeRedistributionCost (GaussPoint *gp)
 Returns the relative redistribution cost of the receiver. More...
 
virtual void initTempStatus (GaussPoint *gp)
 Initializes temporary variables stored in integration point status at the beginning of new time step. More...
 
virtual int setIPValue (const FloatArray &value, GaussPoint *gp, InternalStateType type)
 Sets the value of a certain variable at a given integration point to the given value. 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 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 void printOutputAt (FILE *file, TimeStep *tStep)
 Prints output of receiver to stream, for given time step. 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

double viscosity
 Viscosity of fluid. More...
 
double paramM
 Parameter of van Genuchten law. More...
 
double paramA
 Parameter of van Genuchten law. More...
 
double permeability
 Intrinsic permeability of porous material. More...
 
double porosity
 Porosity of porous material. More...
 
double density
 Density of fluid. More...
 
int conType
 Type of conductivity and capcity laws. More...
 
int capacity
 Type of conductivity and capcity laws. More...
 
double thetaS
 Relative saturated water content. More...
 
double thetaR
 Residual water content. More...
 
double thetaM
 modified water content More...
 
double crackTortuosity
 crack tortuosity More...
 
double crackLimit
 crack limit More...
 
double suctionAirEntry
 suction air entry value More...
 
MaterialMode matMode
 Material mode for convenient access. More...
 
- Protected Attributes inherited from oofem::Material
Dictionary propertyDictionary
 Property dictionary. More...
 
double castingTime
 Casting time. 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 constitutive model for saturated and unsaturated porous materials for lattice elements.

Definition at line 102 of file latticetransmat.h.

Constructor & Destructor Documentation

oofem::LatticeTransportMaterial::LatticeTransportMaterial ( int  n,
Domain d 
)
inline

Definition at line 152 of file latticetransmat.h.

virtual oofem::LatticeTransportMaterial::~LatticeTransportMaterial ( )
inlinevirtual

Member Function Documentation

double oofem::LatticeTransportMaterial::computeCapacity ( double  suction,
GaussPoint gp 
)

Computes the capacity.

Parameters
suctionCapillary stress
gpIntegration point.

Definition at line 251 of file latticetransmat.C.

References capacity, conType, density, give(), paramA, paramM, suctionAirEntry, thetaM, and thetaR.

Referenced by giveCharacteristicValue().

double oofem::LatticeTransportMaterial::computeMass ( FloatArray stateVector,
GaussPoint gp 
)

Computes the mass.

Parameters
stateVectorCapillary stress
gpIntegration point.
MaterialStatus * oofem::LatticeTransportMaterial::CreateStatus ( GaussPoint gp) const
virtual

Creates new copy of associated status and inserts it into given integration point.

Parameters
gpIntegration point where newly created status will be stored.
Returns
Reference to new status.

Reimplemented from oofem::TransportMaterial.

Definition at line 275 of file latticetransmat.C.

References oofem::FEMComponent::domain.

double oofem::LatticeTransportMaterial::give ( int  aProperty,
GaussPoint gp 
)
virtual

Returns the value of material property 'aProperty'.

Property must be identified by unique int id. Integration point also passed to allow for materials with spatially varying properties

Parameters
aPropertyID of property requested.
gpIntegration point,
Returns
Property value.

Reimplemented from oofem::Material.

Definition at line 120 of file latticetransmat.C.

References oofem::Material::give(), HeatCapaCoeff, and permeability.

Referenced by computeCapacity(), and computeConductivity().

virtual void oofem::LatticeTransportMaterial::giveCharacteristicMatrix ( FloatMatrix answer,
MatResponseMode  mode,
GaussPoint gp,
TimeStep tStep 
)
inlinevirtual

Computes characteristic matrix of receiver in given integration point.

The algorithm should use temporary or equilibrium history variables stored in integration point status to compute and return required result.

Parameters
answerContains result.
modeMaterial response mode.
gpIntegration point.
tStepTime step (most models are able to respond only when tStep is current time step).

Implements oofem::TransportMaterial.

Definition at line 158 of file latticetransmat.h.

double oofem::LatticeTransportMaterial::giveCharacteristicValue ( MatResponseMode  mode,
GaussPoint gp,
TimeStep tStep 
)
virtual

Computes the characteristic value of receiver in given integration point, respecting its history.

The algorithm should use temporary or equilibrium history variables stored in integration point status to compute and return required result.

Parameters
modeMaterial response mode.
gpIntegration point.
tStepTime step (most models are able to respond only when tStep is current time step).

Implements oofem::TransportMaterial.

Definition at line 133 of file latticetransmat.C.

References oofem::FloatArray::at(), computeCapacity(), computeConductivity(), oofem::Material::giveStatus(), oofem::TransportMaterialStatus::giveTempField(), and OOFEM_ERROR.

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

Implements oofem::FEMComponent.

Definition at line 191 of file latticetransmat.h.

References oofem::MaterialStatus::initializeFrom().

void oofem::LatticeTransportMaterial::giveFluxVector ( FloatArray answer,
GaussPoint gp,
const FloatArray grad,
const FloatArray field,
TimeStep tStep 
)
virtual

Returns the flux for the field and its gradient.

Todo:
{ Should the field variable just be a scalar? This might change when we rethink the coupled-fields approach. Now its either just [temperature], or [temperature, concentration] so to cover both cases there is a floatarray. }
Parameters
answerThe flux.
gpGauss point.
gradGradient of the primary field, usually the main input.
fieldThe value of the field itself.
tStepActive time step.

Implements oofem::TransportMaterial.

Definition at line 109 of file latticetransmat.C.

References oofem::FloatArray::at(), oofem::FloatArray::beScaled(), computeConductivity(), oofem::Material::giveStatus(), and oofem::TransportMaterialStatus::setTempField().

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

Implements oofem::FEMComponent.

Definition at line 190 of file latticetransmat.h.

References _IFT_LatticeTransportMaterial_Name.

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

Definition at line 50 of file latticetransmat.C.

References _IFT_LatticeTransportMaterial_a, _IFT_LatticeTransportMaterial_c, _IFT_LatticeTransportMaterial_clim, _IFT_LatticeTransportMaterial_contype, _IFT_LatticeTransportMaterial_ctor, _IFT_LatticeTransportMaterial_k, _IFT_LatticeTransportMaterial_m, _IFT_LatticeTransportMaterial_paev, _IFT_LatticeTransportMaterial_thetam, _IFT_LatticeTransportMaterial_thetar, _IFT_LatticeTransportMaterial_thetas, _IFT_LatticeTransportMaterial_vis, capacity, conType, crackLimit, crackTortuosity, oofem::Material::initializeFrom(), IR_GIVE_FIELD, IR_GIVE_OPTIONAL_FIELD, OOFEM_ERROR, OOFEM_WARNING, paramA, paramM, permeability, suctionAirEntry, thetaM, thetaR, thetaS, and viscosity.

Member Data Documentation

int oofem::LatticeTransportMaterial::capacity
protected

Type of conductivity and capcity laws.

Definition at line 127 of file latticetransmat.h.

Referenced by computeCapacity(), and initializeFrom().

int oofem::LatticeTransportMaterial::conType
protected

Type of conductivity and capcity laws.

Definition at line 124 of file latticetransmat.h.

Referenced by computeCapacity(), computeConductivity(), and initializeFrom().

double oofem::LatticeTransportMaterial::crackLimit
protected

crack limit

Definition at line 142 of file latticetransmat.h.

Referenced by computeConductivity(), and initializeFrom().

double oofem::LatticeTransportMaterial::crackTortuosity
protected

crack tortuosity

Definition at line 139 of file latticetransmat.h.

Referenced by computeConductivity(), and initializeFrom().

double oofem::LatticeTransportMaterial::density
protected

Density of fluid.

Definition at line 121 of file latticetransmat.h.

Referenced by computeCapacity(), and computeConductivity().

MaterialMode oofem::LatticeTransportMaterial::matMode
protected

Material mode for convenient access.

Definition at line 149 of file latticetransmat.h.

Referenced by computeConductivity().

double oofem::LatticeTransportMaterial::paramA
protected

Parameter of van Genuchten law.

Definition at line 112 of file latticetransmat.h.

Referenced by computeCapacity(), computeConductivity(), and initializeFrom().

double oofem::LatticeTransportMaterial::paramM
protected

Parameter of van Genuchten law.

Definition at line 109 of file latticetransmat.h.

Referenced by computeCapacity(), computeConductivity(), and initializeFrom().

double oofem::LatticeTransportMaterial::permeability
protected

Intrinsic permeability of porous material.

Definition at line 115 of file latticetransmat.h.

Referenced by computeConductivity(), give(), and initializeFrom().

double oofem::LatticeTransportMaterial::porosity
protected

Porosity of porous material.

Definition at line 118 of file latticetransmat.h.

double oofem::LatticeTransportMaterial::suctionAirEntry
protected

suction air entry value

Definition at line 146 of file latticetransmat.h.

Referenced by computeCapacity(), computeConductivity(), and initializeFrom().

double oofem::LatticeTransportMaterial::thetaM
protected

modified water content

Definition at line 136 of file latticetransmat.h.

Referenced by computeCapacity(), computeConductivity(), and initializeFrom().

double oofem::LatticeTransportMaterial::thetaR
protected

Residual water content.

Definition at line 133 of file latticetransmat.h.

Referenced by computeCapacity(), computeConductivity(), and initializeFrom().

double oofem::LatticeTransportMaterial::thetaS
protected

Relative saturated water content.

Definition at line 130 of file latticetransmat.h.

Referenced by computeConductivity(), and initializeFrom().

double oofem::LatticeTransportMaterial::viscosity
protected

Viscosity of fluid.

Definition at line 106 of file latticetransmat.h.

Referenced by computeConductivity(), 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:37 for OOFEM by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2011