CG  Version 25
Public Types | Public Member Functions | Protected Attributes | List of all members
GridMaterialProperties Class Reference

#include <GridMaterialProperties.h>

Public Types

enum  MaterialFormatEnum { constantMaterialProperties =0, piecewiseConstantMaterialProperties, variableMaterialProperties }
 

Public Member Functions

 GridMaterialProperties ()
 Construct the object that manages and stores the material properties on a component grid.
 
 ~GridMaterialProperties ()
 
MaterialFormatEnum getMaterialFormat () const
 Return the material format for this grid.
 
void setMaterialFormat (const MaterialFormatEnum materialFormat)
 Set the material format for this grid.
 
void setNumberOfMaterialProperties (const int numberOfMaterialProperties)
 
int getNumberOfMaterialProperties () const
 
void setMaterialName (const int m, const aString &materialName)
 
const aString & getMaterialName (const int m) const
 
IntegerArray & getMaterialIndexArray ()
 Return the index array for piecewise constant materials.
 
RealArray & getMaterialValuesArray ()
 
RealArray & getVariableMaterialValuesArray ()
 Return the array that contains the variable material properties.
 

Protected Attributes

DataBase dbase
 

Member Enumeration Documentation

Enumerator
constantMaterialProperties 
piecewiseConstantMaterialProperties 
variableMaterialProperties 

Constructor & Destructor Documentation

GridMaterialProperties::GridMaterialProperties ( )

Construct the object that manages and stores the material properties on a component grid.

References constantMaterialProperties, and dbase.

GridMaterialProperties::~GridMaterialProperties ( )

Member Function Documentation

GridMaterialProperties::MaterialFormatEnum GridMaterialProperties::getMaterialFormat ( ) const
IntegerArray & GridMaterialProperties::getMaterialIndexArray ( )

Return the index array for piecewise constant materials.

Suppose that the material property "m" (e.g. lambda, mu,...) takes on 3 values over the grid, materialValues(m,i), i=0,1,2. The properties of material "m" at a grid point (i1,i2,i3) are accessed using materialValue(m, materialIndex(i1,i2,i3)). The materialIndex array thus holds the

References dbase.

Referenced by DomainSolver::getMaterialProperties(), DomainSolver::setVariableMaterialProperties(), and DomainSolver::userDefinedMaterialProperties().

const aString & GridMaterialProperties::getMaterialName ( const int  m) const
RealArray & GridMaterialProperties::getMaterialValuesArray ( )
int GridMaterialProperties::getNumberOfMaterialProperties ( ) const

References dbase.

RealArray & GridMaterialProperties::getVariableMaterialValuesArray ( )

Return the array that contains the variable material properties.

The material properties at a grid point (i1,i2,i3) are accessed using materialValue(i1,i2,i3,m), m=0,1,...,numberOfMaterialProperties-1

References dbase.

void GridMaterialProperties::setMaterialFormat ( const MaterialFormatEnum  materialFormat)

Set the material format for this grid.

References dbase.

Referenced by DomainSolver::setVariableMaterialProperties().

void GridMaterialProperties::setMaterialName ( const int  m,
const aString &  materialName 
)
void GridMaterialProperties::setNumberOfMaterialProperties ( const int  numberOfMaterialProperties)

References dbase.

Member Data Documentation

DataBase GridMaterialProperties::dbase
protected

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