Chaste Release::3.1
SolidMechanicsProblemDefinition< DIM > Class Template Reference

#include <SolidMechanicsProblemDefinition.hpp>

Inheritance diagram for SolidMechanicsProblemDefinition< DIM >:
Collaboration diagram for SolidMechanicsProblemDefinition< DIM >:

List of all members.

Public Member Functions

 SolidMechanicsProblemDefinition (QuadraticMesh< DIM > &rMesh)
virtual ~SolidMechanicsProblemDefinition ()
void SetMaterialLaw (CompressibilityType compressibilityType, AbstractMaterialLaw< DIM > *pMaterialLaw)
void SetMaterialLaw (CompressibilityType compressibilityType, std::vector< AbstractMaterialLaw< DIM > * > &rMaterialLaws)
bool IsHomogeneousMaterial ()
CompressibilityType GetCompressibilityType ()
AbstractIncompressibleMaterialLaw
< DIM > * 
GetIncompressibleMaterialLaw (unsigned elementIndex)
AbstractCompressibleMaterialLaw
< DIM > * 
GetCompressibleMaterialLaw (unsigned elementIndex)
void SetZeroDisplacementNodes (std::vector< unsigned > &rFixedNodes)
void SetFixedNodes (std::vector< unsigned > &rFixedNodes, std::vector< c_vector< double, DIM > > &rFixedNodeLocation)
virtual void Validate ()
void SetSolveUsingSnes (bool solveUsingSnes=true)
bool GetSolveUsingSnes ()

Private Member Functions

void CheckCastSuccess (CompressibilityType compressibilityType, AbstractMaterialLaw< DIM > *pMaterialLaw)

Private Attributes

std::vector
< AbstractIncompressibleMaterialLaw
< DIM > * > 
mIncompressibleMaterialLaws
std::vector
< AbstractCompressibleMaterialLaw
< DIM > * > 
mCompressibleMaterialLaws
bool mIsHomogeneousMaterial
CompressibilityType mCompressibilityType
bool mSolveUsingSnes

Detailed Description

template<unsigned DIM>
class SolidMechanicsProblemDefinition< DIM >

A class for specifying various parts of a solid mechanics problem, in particular the material laws for the deforming body, and (inheriting functionality from a base class): fixed nodes information, the body force (per unit mass) (usually acceleration due to gravity or zero), the traction boundary conditions, and the density.

Definition at line 49 of file SolidMechanicsProblemDefinition.hpp.


Constructor & Destructor Documentation

template<unsigned DIM>
SolidMechanicsProblemDefinition< DIM >::SolidMechanicsProblemDefinition ( QuadraticMesh< DIM > &  rMesh)

Constructor. Note body force initialised to zero and density to 1.0

Parameters:
rMeshTesh being solved on

Definition at line 43 of file SolidMechanicsProblemDefinition.cpp.

template<unsigned DIM>
virtual SolidMechanicsProblemDefinition< DIM >::~SolidMechanicsProblemDefinition ( ) [inline, virtual]

Destructor

Definition at line 94 of file SolidMechanicsProblemDefinition.hpp.


Member Function Documentation

template<unsigned DIM>
void SolidMechanicsProblemDefinition< DIM >::CheckCastSuccess ( CompressibilityType  compressibilityType,
AbstractMaterialLaw< DIM > *  pMaterialLaw 
) [private]

Helper function for checking whether a dynamic_cast succeeded or not, and throwing an exception if it failed.

Parameters:
compressibilityTypecompressibility type
pMaterialLawmaterial law

Definition at line 202 of file SolidMechanicsProblemDefinition.cpp.

References EXCEPTION.

template<unsigned DIM>
CompressibilityType SolidMechanicsProblemDefinition< DIM >::GetCompressibilityType ( )

Get whether the material is incompressible or compressible. SetMaterialLaw() must be called before calling this. (Which can be checked by calling Validate()).

Definition at line 155 of file SolidMechanicsProblemDefinition.cpp.

Referenced by CompressibleNonlinearElasticitySolver< DIM >::CompressibleNonlinearElasticitySolver(), and IncompressibleNonlinearElasticitySolver< DIM >::IncompressibleNonlinearElasticitySolver().

template<unsigned DIM>
AbstractCompressibleMaterialLaw< DIM > * SolidMechanicsProblemDefinition< DIM >::GetCompressibleMaterialLaw ( unsigned  elementIndex)

Get the material law for a given element, when the body is compressible. An assertion will fail if GetCompressibilityType()!=COMPRESSIBLE. If the material is homogeneous, it doesn't matter what the element index is.

Parameters:
elementIndexindex of element

Definition at line 184 of file SolidMechanicsProblemDefinition.cpp.

template<unsigned DIM>
AbstractIncompressibleMaterialLaw< DIM > * SolidMechanicsProblemDefinition< DIM >::GetIncompressibleMaterialLaw ( unsigned  elementIndex)

Get the material law for a given element, when the body is incompressible. An assertion will fail if GetCompressibilityType()!=INCOMPRESSIBLE. If the material is homogeneous, it doesn't matter what the element index is.

Parameters:
elementIndexindex of element

Definition at line 166 of file SolidMechanicsProblemDefinition.cpp.

template<unsigned DIM>
bool SolidMechanicsProblemDefinition< DIM >::GetSolveUsingSnes ( ) [inline]

Get whether solver should use Petsc SNES nonlinear solver or not

Definition at line 195 of file SolidMechanicsProblemDefinition.hpp.

References SolidMechanicsProblemDefinition< DIM >::mSolveUsingSnes.

template<unsigned DIM>
bool SolidMechanicsProblemDefinition< DIM >::IsHomogeneousMaterial ( )

Get whether the material is homogeneous or heterogeneous. SetMaterialLaw() must be called before calling this.

Definition at line 147 of file SolidMechanicsProblemDefinition.cpp.

template<unsigned DIM>
void SolidMechanicsProblemDefinition< DIM >::SetFixedNodes ( std::vector< unsigned > &  rFixedNodes,
std::vector< c_vector< double, DIM > > &  rFixedNodeLocation 
)

Set a list of nodes to be fixed, with their corresponding new LOCATIONS (not displacements). (This class will store as displacements though, and it is displacements that will be returned by rGetDirichletNodeValues).

Parameters:
rFixedNodesthe fixed node indices
rFixedNodeLocationcorresponding locations

Definition at line 52 of file SolidMechanicsProblemDefinition.cpp.

template<unsigned DIM>
void SolidMechanicsProblemDefinition< DIM >::SetMaterialLaw ( CompressibilityType  compressibilityType,
std::vector< AbstractMaterialLaw< DIM > * > &  rMaterialLaws 
)

Set a vector of material laws for the body, one for each element in the mesh (the heterogeneous case). If compressibilityType==INCOMPRESSIBLE, the material law pointer will be checked at run-time that it is of type `AbstractIncompressibleMaterialLaw`, and similarly for the compressible case. Any previous material information will be deleted.

Parameters:
compressibilityTypeeither 'INCOMPRESSIBLE' or 'COMPRESSIBLE'
rMaterialLawsVector of pointers to material laws

Definition at line 110 of file SolidMechanicsProblemDefinition.cpp.

template<unsigned DIM>
void SolidMechanicsProblemDefinition< DIM >::SetMaterialLaw ( CompressibilityType  compressibilityType,
AbstractMaterialLaw< DIM > *  pMaterialLaw 
)

Set a material law for the entire body (ie the homogeneous case). If compressibilityType==INCOMPRESSIBLE, the material law pointer will be checked at run-time that it is of type `AbstractIncompressibleMaterialLaw`, and similarly for the compressible case. Any previous material information will be deleted.

Parameters:
compressibilityTypeeither 'INCOMPRESSIBLE' or 'COMPRESSIBLE'
pMaterialLawThe material law for the entire body

Definition at line 83 of file SolidMechanicsProblemDefinition.cpp.

template<unsigned DIM>
void SolidMechanicsProblemDefinition< DIM >::SetSolveUsingSnes ( bool  solveUsingSnes = true) [inline]

Tell the solver class whether to use the PETSc SNES solver (the petsc nonlinear solver) or its own nonlinear solve implementation.

Parameters:
solveUsingSnessolve using Snes or not

Definition at line 187 of file SolidMechanicsProblemDefinition.hpp.

References SolidMechanicsProblemDefinition< DIM >::mSolveUsingSnes.

template<unsigned DIM>
void SolidMechanicsProblemDefinition< DIM >::SetZeroDisplacementNodes ( std::vector< unsigned > &  rFixedNodes) [inline]

Set a list of nodes (indices) to be fixed in space with zero displacement

Parameters:
rFixedNodesthe fixed nodes

Definition at line 154 of file SolidMechanicsProblemDefinition.hpp.

References ContinuumMechanicsProblemDefinition< DIM >::SetZeroDirichletNodes().

template<unsigned DIM>
void SolidMechanicsProblemDefinition< DIM >::Validate ( ) [virtual]

Check all variables are set appropriately. Exceptions are thrown if any are not. Derived classes can override but should call this version as well.

Reimplemented from ContinuumMechanicsProblemDefinition< DIM >.

Reimplemented in ElectroMechanicsProblemDefinition< DIM >.

Definition at line 220 of file SolidMechanicsProblemDefinition.cpp.

References EXCEPTION, and ContinuumMechanicsProblemDefinition< DIM >::Validate().

Referenced by ElectroMechanicsProblemDefinition< DIM >::Validate().


Member Data Documentation

template<unsigned DIM>
CompressibilityType SolidMechanicsProblemDefinition< DIM >::mCompressibilityType [private]

Whether the material is incompressible or compressible. (CompressibilityType is an enumeration).

Definition at line 72 of file SolidMechanicsProblemDefinition.hpp.

template<unsigned DIM>
std::vector<AbstractCompressibleMaterialLaw<DIM>*> SolidMechanicsProblemDefinition< DIM >::mCompressibleMaterialLaws [private]

The material law, in the case of compressible material laws. This vector is either of size 1, representing a homogeneous material, or of size num_elements, representing a heterogeneous material, with a material law per element. If the material is incompressible, this vector will be of size zero.

Definition at line 66 of file SolidMechanicsProblemDefinition.hpp.

template<unsigned DIM>
std::vector<AbstractIncompressibleMaterialLaw<DIM>*> SolidMechanicsProblemDefinition< DIM >::mIncompressibleMaterialLaws [private]

The material law, in the case of incompressible material laws. This vector is either of size 1, representing a homogeneous material, or of size num_elements, representing a heterogeneous material, with a material law per element. If he material is compressible, this vector will be of size zero.

Definition at line 60 of file SolidMechanicsProblemDefinition.hpp.

template<unsigned DIM>
bool SolidMechanicsProblemDefinition< DIM >::mIsHomogeneousMaterial [private]

Whether the material is homogeneous (same material law everywhere) or heterogeneous

Definition at line 69 of file SolidMechanicsProblemDefinition.hpp.

template<unsigned DIM>
bool SolidMechanicsProblemDefinition< DIM >::mSolveUsingSnes [private]

Whether the solver will use Petsc SNES or not. See dox for Set method below

Definition at line 75 of file SolidMechanicsProblemDefinition.hpp.

Referenced by SolidMechanicsProblemDefinition< DIM >::GetSolveUsingSnes(), and SolidMechanicsProblemDefinition< DIM >::SetSolveUsingSnes().


The documentation for this class was generated from the following files: