AbstractMaterial
AbstractMaterial_
class is designed to handle the material properties in simulations. This class currently has following sub-classes.
- SolidMaterial
PorousMaterial
FluidMaterial
You can see the structure of AbstractMaterial
here.
AbstractMaterial_
contains materials in a vector of UserFunction. Therefore, you should know read about UserFunction
before getting started with the AbstractMaterial_.
How to initiate?
To initiate an instance of AbstractMaterial_
follow the following steps:
Step-1:
First, we will call SetAbstractMaterialParam method.
Step-2:
Then, we will call Initiate method.
Step-3:
After we have initiated an instance of AbstractMaterial_
, we will ADD material to it by calling AddMaterial. Note that this routine just register a material name and allocate space for defining materal as a UserFunction
.
Step-4:
After registering a material, we can get the pointer of UserFunction by calling the method GetMaterialPointer. We should initiate this pointer as described in the documentation of UserFunction.
You can also initiate the material from toml
configuration and by using the method called ImportFromToml
You can also initiate the material from hdf5file
by using the method called Import
Methods
📄️ Structure
AbstractMaterial_ is an abstract class for defining material and its behavior.
📄️ AddMaterial
Add material to AbstractMaterial_.
📄️ Deallocate
Deallocate data stored in the AbstractMaterial_ class.
📄️ Display
Display the content of AbstractMaterial_
📄️ GetMaterialPointer
Get the pointer to the UserFunction for the given material name.
📄️ GetPrefix
Get the prefix.
📄️ Import
Initiate an instance of AbstractMaterial_ by using HDF5File.
📄️ ImportFromToml
Initiate an instance by using a toml config.
📄️ Initiate
Initiate an instance of AbstractMaterial_ class.
📄️ IsMaterialPresent
This function returns .TRUE. if a material name is registered in AbstractMaterial_ by calling AddMaterial method.
📄️ SetAbstractMaterialParam
Set parameter for initiating the AbstractMaterial_