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

Transort cross-section. More...

#include <simpletransportcrosssection.h>

+ Inheritance diagram for oofem::SimpleTransportCrossSection:
+ Collaboration diagram for oofem::SimpleTransportCrossSection:

Public Member Functions

 SimpleTransportCrossSection (int n, Domain *d)
 Constructor. More...
 
virtual ~SimpleTransportCrossSection ()
 Destructor. More...
 
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 TransportMaterialgiveMaterial ()
 Temporary function that hands out the material. Must be removed for future layered support, but input files will still look the same. More...
 
virtual MaterialgiveMaterial (IntegrationPoint *ip)
 Returns the material associated with the GP. More...
 
virtual bool isCharacteristicMtrxSymmetric (MatResponseMode rMode)
 Check for symmetry of stiffness matrix. More...
 
virtual int giveIPValue (FloatArray &answer, GaussPoint *ip, InternalStateType type, TimeStep *tStep)
 Returns the integration point corresponding value in Reduced form. More...
 
virtual int checkConsistency ()
 Allows programmer to test some internal data, before computation begins. More...
 
virtual int packUnknowns (DataStream &buff, TimeStep *tStep, GaussPoint *gp)
 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 *gp)
 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 *gp)
 Estimates the necessary pack size to hold all packed data of receiver. More...
 
virtual const char * giveClassName () const
 
virtual const char * giveInputRecordName () const
 
- Public Member Functions inherited from oofem::TransportCrossSection
 TransportCrossSection (int n, Domain *d)
 Constructor. More...
 
virtual ~TransportCrossSection ()
 Destructor. More...
 
- Public Member Functions inherited from oofem::CrossSection
 CrossSection (int n, Domain *d)
 Constructor. More...
 
virtual ~CrossSection ()
 Destructor. More...
 
int giveSetNumber () const
 
virtual bool hasProperty (CrossSectionProperty a)
 Returns true if the dictionary contains the requested property. More...
 
virtual double give (CrossSectionProperty a, GaussPoint *gp)
 Returns the value of cross section property at given point. More...
 
virtual double give (CrossSectionProperty a, const FloatArray &coords, Element *elem, bool local=true)
 Returns the value of cross section property at given point (belonging to given element). More...
 
virtual double give (int aProperty, GaussPoint *gp)
 Returns the value of cross section property. More...
 
virtual void printYourself ()
 Prints receiver state on stdout. Useful for debugging. More...
 
virtual int setupIntegrationPoints (IntegrationRule &irule, int npoints, Element *element)
 Sets up integration rule for the given element. More...
 
virtual int setupIntegrationPoints (IntegrationRule &irule, int npointsXY, int npointsZ, Element *element)
 Sets up integration rule for the given element. More...
 
virtual int testCrossSectionExtension (CrossSectExtension ext)
 Returns nonzero, if receiver implements required extension. More...
 
virtual double predictRelativeComputationalCost (GaussPoint *ip)
 Returns the weight representing relative computational cost of receiver The reference cross section is integral model in plane stress. More...
 
virtual double giveRelativeSelfComputationalCost ()
 Returns the weight representing relative computational cost of receiver The reference element is integral model in plane stress. More...
 
virtual double predictRelativeRedistributionCost (GaussPoint *gp)
 
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...
 
- 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

int matNumber
 
double thickness
 
- Protected Attributes inherited from oofem::CrossSection
Dictionary propertyDictionary
 Dictionary for storing cross section parameters (like dimensions). More...
 
int setNumber
 
- 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

Transort cross-section.

It's functionality is to be a wrapper around the material behavior.

Todo:
There will eventually be a layered version of this cross-section, so it must capture all the values.
Author
Mikael Öhman

Definition at line 53 of file simpletransportcrosssection.h.

Constructor & Destructor Documentation

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

Constructor.

Creates cross section with number n belonging to domain d.

Parameters
nCross section number.
dDomain for cross section.

Definition at line 43 of file simpletransportcrosssection.C.

oofem::SimpleTransportCrossSection::~SimpleTransportCrossSection ( )
virtual

Destructor.

Definition at line 45 of file simpletransportcrosssection.C.

Member Function Documentation

int oofem::SimpleTransportCrossSection::checkConsistency ( )
virtual

Allows programmer to test some internal data, before computation begins.

For example, one may use this function, to ensure that element has material with required capabilities is assigned to element. This must be done after all mesh components are instanciated.

Returns
Nonzero if receiver is consistent.

Reimplemented from oofem::FEMComponent.

Definition at line 75 of file simpletransportcrosssection.C.

References oofem::FEMComponent::checkConsistency(), oofem::FEMComponent::domain, oofem::Domain::giveMaterial(), and matNumber.

int oofem::SimpleTransportCrossSection::estimatePackSize ( DataStream buff,
GaussPoint ip 
)
virtual

Estimates the necessary pack size to hold all packed data of receiver.

The corresponding material model service is invoked. The nature of packed data is typically material model dependent.

Parameters
buffCommunication buffer.
ipIntegration point.
Returns
Estimate of pack size.

Implements oofem::CrossSection.

Definition at line 125 of file simpletransportcrosssection.C.

References oofem::FEMComponent::domain, oofem::Material::estimatePackSize(), oofem::Domain::giveMaterial(), and matNumber.

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

Implements oofem::FEMComponent.

Definition at line 85 of file simpletransportcrosssection.h.

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

Setups the input record string of receiver.

Parameters
inputDynamic input record to be filled by receiver.

Reimplemented from oofem::CrossSection.

Definition at line 66 of file simpletransportcrosssection.C.

References _IFT_SimpleTransportCrossSection_material, oofem::CrossSection::giveInputRecord(), matNumber, and oofem::DynamicInputRecord::setField().

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

Implements oofem::FEMComponent.

Definition at line 86 of file simpletransportcrosssection.h.

References _IFT_SimpleTransportCrossSection_Name.

int oofem::SimpleTransportCrossSection::giveIPValue ( FloatArray answer,
GaussPoint ip,
InternalStateType  type,
TimeStep tStep 
)
virtual

Returns the integration point corresponding value in Reduced form.

Parameters
answercontain corresponding ip value, zero sized if not available
ipIntegration point.
typeDetermines the type of internal variable.
tStepTime step.
Returns
Nonzero if o.k, zero otherwise.

Reimplemented from oofem::CrossSection.

Definition at line 99 of file simpletransportcrosssection.C.

References oofem::FEMComponent::domain, oofem::Material::giveIPValue(), oofem::Domain::giveMaterial(), and matNumber.

TransportMaterial * oofem::SimpleTransportCrossSection::giveMaterial ( )
virtual

Temporary function that hands out the material. Must be removed for future layered support, but input files will still look the same.

Implements oofem::TransportCrossSection.

Definition at line 86 of file simpletransportcrosssection.C.

References oofem::FEMComponent::domain, oofem::Domain::giveMaterial(), and matNumber.

Material * oofem::SimpleTransportCrossSection::giveMaterial ( IntegrationPoint ip)
virtual

Returns the material associated with the GP.

Default implementation uses gp->giveMaterial() for backwards compatibility, but it should be overloaded in each specialized cross-section.

Implements oofem::CrossSection.

Definition at line 92 of file simpletransportcrosssection.C.

References oofem::FEMComponent::domain, oofem::Domain::giveMaterial(), and matNumber.

IRResultType oofem::SimpleTransportCrossSection::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::CrossSection.

Definition at line 49 of file simpletransportcrosssection.C.

References _IFT_SimpleTransportCrossSection_material, _IFT_SimpleTransportCrossSection_thickness, oofem::Dictionary::add(), oofem::Dictionary::clear(), oofem::CS_Thickness, oofem::InputRecord::hasField(), oofem::CrossSection::initializeFrom(), IR_GIVE_FIELD, matNumber, oofem::CrossSection::propertyDictionary, and thickness.

bool oofem::SimpleTransportCrossSection::isCharacteristicMtrxSymmetric ( MatResponseMode  rMode)
virtual

Check for symmetry of stiffness matrix.

Default implementation returns true. It can be moved to base Cross section class in the future.

Parameters
rModeResponse mode of material.
Returns
True if stiffness matrix of receiver is symmetric.

Reimplemented from oofem::CrossSection.

Definition at line 106 of file simpletransportcrosssection.C.

References oofem::FEMComponent::domain, oofem::Domain::giveMaterial(), oofem::Material::isCharacteristicMtrxSymmetric(), and matNumber.

int oofem::SimpleTransportCrossSection::packUnknowns ( DataStream buff,
TimeStep tStep,
GaussPoint ip 
)
virtual

Pack all necessary data of integration point (according to element parallel_mode) into given communication buffer.

The corresponding material model service for particular integration point is invoked. The nature of packed data is material model dependent. Typically, for material of "local" response (response depends only on integration point local state) no data are exchanged. For "nonlocal" constitutive models the send/receive of local values which undergo averaging is performed between local and corresponding remote elements.

Parameters
buffCommunication buffer.
tStepSolution step.
ipIntegration point.
Returns
Nonzero if successful.

Implements oofem::CrossSection.

Definition at line 113 of file simpletransportcrosssection.C.

References oofem::FEMComponent::domain, oofem::Domain::giveMaterial(), matNumber, and oofem::Material::packUnknowns().

int oofem::SimpleTransportCrossSection::unpackAndUpdateUnknowns ( DataStream buff,
TimeStep tStep,
GaussPoint ip 
)
virtual

Unpack and updates all necessary data of given integration point (according to element parallel_mode) into given communication buffer.

See also
packUnknowns service.
Parameters
buffCommunication buffer.
tStepSolution step.
ipIntegration point.
Returns
Nonzero if successful.

Implements oofem::CrossSection.

Definition at line 119 of file simpletransportcrosssection.C.

References oofem::FEMComponent::domain, oofem::Domain::giveMaterial(), matNumber, and oofem::Material::unpackAndUpdateUnknowns().

Member Data Documentation

double oofem::SimpleTransportCrossSection::thickness
protected

Definition at line 57 of file simpletransportcrosssection.h.

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