Xfem
The Xfem Plugin
Public Member Functions | Static Public Member Functions | Protected Types | Private Attributes | List of all members
XfemHydroMechanicalMaterial Class Reference

Basic class for the elastic xfem material plugin object. More...

#include <xfemHydroMechanicalMaterial.h>

Inheritance diagram for XfemHydroMechanicalMaterial:
Inheritance graph
[legend]
Collaboration diagram for XfemHydroMechanicalMaterial:
Collaboration graph
[legend]

Public Member Functions

 XfemHydroMechanicalMaterial (int typeIndex, QString typeName, const GmLogCategory &logger)
 Constructor. Gets as parameters the material index and its name.
 
virtual const QVariantMap * materialMetaDataMap ()
 Returns a pointer to the material attribute map, built when the function is called for the first time. More...
 
virtual void tangentModulus (const GmElement *e, GmMatrix &Dep, const GmpMechanicPoint *mp, const GmVector *coord, unsigned nc, unsigned ips) const
 
virtual void returnMapping (const GmElement *e, GmMatrix &Dep, const GmpMechanicPoint *mp, const GmVector *coord, unsigned nc, unsigned ips) const
 
virtual double solidBulkModulus (const GmElement *e, const GmVector *coord, int ip) const
 Sets the initial conditions. More...
 
virtual double nonWettingBulkModulus (const GmElement *e, const GmVector *coord, int ip) const
 Returns the solid bulk mudulus.
 
virtual double fluidViscosity (const GmElement *e, const GmVector *coord, int ip) const
 Returns the dynamic fluid viscosity.
 
virtual double interfaceBiotModulus (const GmElement *e, const GmVector *coord, int ip) const
 Returns the discontinuity Biot's Modulus.
 
virtual double leakoffTop (const GmElement *e, const GmVector *coord, int ip) const
 Returns the leakoff coefficient at the top.
 
virtual double leakoffBottom (const GmElement *e, const GmVector *coord, int ip) const
 Returns the leakoff coefficient at the Bottom.
 
virtual double initialWaterSaturation (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double residualWaterSaturation (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double bubblingPressure (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double nWFluidViscosity (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double intrinsicPermeability (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double wettingFluidDensity (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double nonWettingFluidDensity (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double solidDensity (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double gammaNonWettingFluid (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double specificHeatWettingFluid (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double specificHeatNonWettingFluid (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double specificHeatSolid (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double thermalConductivityWettingFluid (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double thermalConductivityNonWettingFluid (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double thermalConductivitySolid (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double thermalExpansionWettingFluid (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double thermalExpansionNonWettingFluid (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double thermalExpansionSolid (const GmElement *e, const GmVector *coord, int ip) const
 
virtual double cubicLaw (const GmElement *e, const GmVector *coord, int ip, double wn, bool cubiclaw) const
 Returns the hydraulic conductivity according to the cubic Law.
 
virtual double cubicLawMP (const GmElement *e, const GmVector *coord, int ip, double wn, bool cubiclaw) const
 Returns the hydraulic conductivity according to the cubic Law.
 
- Public Member Functions inherited from XfemMaterial
 XfemMaterial (int typeIndex, QString typeName, const GmLogCategory &logger)
 Constructor. Gets as parameters the material index and its name.
 
void setPhysicsMaterials (GmpFemPhysicsCommonMaterial *hydro, GmpFemPhysicsCommonMaterial *mechano)
 Sets the hydraulic and mechanical materials for this material. Materials CAN be NULL for a physics.
 
void setPhysicsDiscontinuityMaterials (GmpFemPhysicsCommonMaterial *hydro, GmpFemPhysicsCommonMaterial *mechano)
 Sets the hydraulic and mechanical materials for this discontinuity material. Materials CAN be NULL for a physics.
 
GmpHydraulicMaterial * hydro () const
 Returns the hydraulic material or NULL if none was configured.
 
GmpMechanicalMaterial * mechanical () const
 Returns the mechancial material or NULL if none was configured or if the material is an interface material.
 
GmpInterfaceMaterial * mechanicalDiscontinuity () const
 Returns the mechancial material or NULL if none was configured or if the material is an interface material.
 
virtual double maximumPrincipalStress (const GmElement *e, const GmVector *coord, int ip) const
 Returns the maximum principal stress.
 
virtual double fractureOpening (const GmElement *e, const GmVector *coord, int ip) const
 Returns the initial fracture opening.
 
virtual double normalElasticStiffness (const GmElement *e, const GmVector *coord, int ip) const
 Returns the normal elastic stiffness of the interface element.
 
virtual double shearElasticStiffness (const GmElement *e, const GmVector *coord, int ip) const
 Returns the shear elastic stiffness of the interface element.
 
virtual double shearElasticStiffnessTwo (const GmElement *e, const GmVector *coord, int ip) const
 Returns the shear elastic stiffness 2 of the interface element (required in 3D)
 
virtual double faultCohesion (const GmElement *e, const GmVector *coord, int ip) const
 Returns the cohesion of the discontinuity.
 
virtual double faultFrictionAngle (const GmElement *e, const GmVector *coord, int ip) const
 Returns the friction angle of the discontinuity.
 
virtual double faultDilationAngle (const GmElement *e, const GmVector *coord, int ip) const
 Returns the dilation angle of the discontinuity.
 
virtual double cutOffTension (const GmElement *e, const GmVector *coord, int ip) const
 Returns the cut-off tension of the discontinuity.
 
virtual double fractureEnergy (const GmElement *e, const GmVector *coord, int ip) const
 Returns the Fracture energy.
 
virtual double shearModulus (const GmElement *e, const GmVector *coord, int ip) const
 Returns the Fracture energy.
 
virtual double gravitationalAcceleration (const GmElement *e, const GmVector *coord, int ip) const
 Returns the Fracture energy.
 

Static Public Member Functions

static GmpFemPhysicsCommonMaterial * instance (GmSimulationData *simulation, int typeIndex, QString typeName, const GmLogCategory &logger)
 A "factory" function used to register the material with the physics material factory.
 
- Static Public Member Functions inherited from XfemMaterial
static GmpFemPhysicsCommonMaterial * instance (GmSimulationData *simulation, int typeIndex, QString typeName, const GmLogCategory &logger)
 A "factory" function used to register the material with the physics material factory.
 

Protected Types

enum  ElemHMXfemPropertyIds {
  KSS_ID = XfemMaterial::NUM_PROPERTY_IDS, UFw_ID, MFw_ID, LKT_ID,
  LKB_ID, SIW_ID, SRW_ID, PBB_ID,
  UFnw_ID, Knw_ID, Kim_ID, rhow_ID,
  rhonw_ID, rhos_ID, Gnw_ID, CTw_ID,
  CTnw_ID, CTs_ID, KTw_ID, KTnw_ID,
  KTs_ID, BTw_ID, BTnw_ID, BTs_ID,
  NUM_PROPERTY_IDS
}
 IDs for material element properties. More...
 
- Protected Types inherited from XfemMaterial
enum  ElemXfemPropertyIds {
  SPMax_ID, GAP_ID, Kni_ID, Ksi_ID,
  Kti_ID, CF_ID, PHIF_ID, PSIF_ID,
  TCUT_ID, Gf_ID, G_ID, GRAV_ID,
  NUM_PROPERTY_IDS
}
 IDs for material element properties. More...
 

Private Attributes

GmpFemPhysicsCommonMaterial * _hydroMaterial
 Hydraulic material.
 
GmpFemPhysicsCommonMaterial * _mechanoMaterial
 Mechanical material. Ps: The mechanical plugin does not have a base class common to all materials.
 

Detailed Description

Basic class for the elastic xfem material plugin object.

Member Enumeration Documentation

◆ ElemHMXfemPropertyIds

enum XfemHydroMechanicalMaterial::ElemHMXfemPropertyIds
protected

IDs for material element properties.

Enumerator
KSS_ID 

Id for retrieving the solid bulk's Modulus accessor.

UFw_ID 

Id for retrieving the dynamic fluid viscosity.

MFw_ID 

Id for retrieving the discontinuity Biot's Modulus.

LKT_ID 

Id for retrieving the leakoff coefficient at the top.

LKB_ID 

Id for retrieving the leakoff coefficient at the bottom.

SIW_ID 

Id for retrieving the initial water saturation.

SRW_ID 

Id for retrieving the residual water saturation.

PBB_ID 

Id for retrieving the bubbling pressure.

UFnw_ID 

Id for retrieving the dynamic non-wetting fluid viscosity.

Knw_ID 

Id for retrieving the dynamic non-wetting fluid bulk's Modulus accessor.

Kim_ID 

Id for retrieving the intrinsic permeability accessor.

rhow_ID 

Id for retrieving the wetting fluid density accessor.

rhonw_ID 

Id for retrieving the non-wetting fluid density accessor.

rhos_ID 

Id for retrieving the solid density accessor.

Gnw_ID 

Id for retrieving the Specific weight of the non-wetting fluid accessor.

CTw_ID 

Id for retrieving the Specific heat capacity of the wetting fluid accessor.

CTnw_ID 

Id for retrieving the Specific heat capacity of the non-wetting fluid accessor.

CTs_ID 

Id for retrieving the Specific heat capacity of the solid accessor.

KTw_ID 

Id for retrieving the thermal conductivity of the wetting fluid accessor.

KTnw_ID 

Id for retrieving the thermal conductivity of the non-wetting fluid accessor.

KTs_ID 

Id for retrieving the thermal conductivity of the solid accessor.

BTw_ID 

Id for retrieving the thermal expansion coefficient of the wetting fluid accessor.

BTnw_ID 

Id for retrieving the thermal expansion coefficient of the non-wetting fluid accessor.

BTs_ID 

Id for retrieving the thermal expansion coefficient of the solid accessor.

NUM_PROPERTY_IDS 

The number of property ids above.

Member Function Documentation

◆ materialMetaDataMap()

const QVariantMap * XfemHydroMechanicalMaterial::materialMetaDataMap ( )
virtual

Returns a pointer to the material attribute map, built when the function is called for the first time.

This table adds the attributes required by the hydroMechanical XFEM Material class,

Reimplemented from XfemMaterial.

◆ solidBulkModulus()

virtual double XfemHydroMechanicalMaterial::solidBulkModulus ( const GmElement *  e,
const GmVector *  coord,
int  ip 
) const
inlinevirtual

Sets the initial conditions.

Returns the solid bulk mudulus

The documentation for this class was generated from the following files:
Generated on Mon Jun 10 2024 19:14:36 for Xfem by   doxygen 1.8.15