gmpHydraulicMaterialMultiPhase.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE.
**
************************************************************************/
 
#ifndef _GEMA_PLUGIN_HYDRAULIC_MATERIAL_MULTIPHASE_H_
#define _GEMA_PLUGIN_HYDRAULIC_MATERIAL_MULTIPHASE_H_
 
#include "gmpMaterialSaturated.h"
 
class GMP_HYDRAULIC_PHYSICS_API_EXPORT GmpHydraulicMaterialMultiPhase: public GmpFemPhysicsCommonMaterial
{
protected:
  enum MultiPhasePropertyIds
  {
 
    K_ID ,           
    Pht_ID,          
    Bp_ID,           
    Kww_ID,          
    Kgg_ID,          
    Uw_ID,           
    Ug_ID,           
    Rhow_ID,         
    Rhog_ID,         
    R_ID,            
    T_ID,            
    Mg_ID,           
    SWR_ID,                          
    SGR_ID,                          
    Pd_ID,                           
 
    // --- NO ADDING BELOW THIS LINE
    NUM_PROPERTY_IDS,  
  };
 
public:
 
  GmpHydraulicMaterialMultiPhase(int typeIndex, QString typeName, const GmLogCategory& logger)
    : GmpFemPhysicsCommonMaterial(typeIndex, typeName, logger) {}
 
  // Sets multiPhase material map
  virtual const QVariantMap* materialMetaDataMap();
 
  virtual void hydraulicConstitutiveModel(const GmElement* e, const GmVector* coord, int ip, GmMatrix& Kw, GmMatrix& Kc, double Sw, const GmpHydraulic::HMaterialPointAccessors& mp, int d) const ;
 
  virtual void permeabilityStiffness(const GmElement* e, const GmVector* coord, int ip, GmMatrix& K) const;
 
  virtual double waterSaturation(const GmElement* e, const GmVector* coord, int ip, double pc) const = 0;
  
  virtual double derivativeWaterSaturation(const GmElement* e, const GmVector* coord, int ip, double pc) const = 0;
 
  virtual double effectiveSaturation(const GmElement* e, const GmVector* coord, int ip, double Sw) const;
  
  virtual double waterRelativePermeability(const GmElement* e, const GmVector* coord, int ip, double Sw) const = 0;
 
  virtual double gasRelativePermeability(const GmElement* e, const GmVector* coord, int ip, double Sw) const = 0;
 
  virtual double intrinsicPermeability(const GmElement* e, const GmVector* coord, int ip) const
  {
      return propertyAc(K_ID)->scalarValueAt(e, coord, ip);
  }
  virtual double porosity(const GmElement* e, const GmVector* coord, int ip) const
  {
    return propertyAc(Pht_ID)->scalarValueAt(e, coord, ip);
  }
 
  double universalGasConstant(const GmElement* e, const GmVector* coord, int ip) const
  {
    return propertyAc(R_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double temperature(const GmElement* e, const GmVector* coord, int ip) const
  {
    return propertyAc(T_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double molarMass(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(Mg_ID) == NULL)
    {
      return 0.0;
    }
    return propertyAc(Mg_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double poreCompressibility(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(Bp_ID) == NULL)
    {
      return 0.0;
    }
    return propertyAc(Bp_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double waterBulkModulus(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(Kww_ID) == NULL)
    {
      return 1.0e25;
    }
    return propertyAc(Kww_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double gasBulkModulus(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(Kgg_ID) == NULL)
    {
      return 1.0e25;
    }
    return propertyAc(Kgg_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double waterViscosity(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(Uw_ID) == NULL)
    {
      return 1.0e25;
    }
    return propertyAc(Uw_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double gasViscosity(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(Ug_ID) == NULL)
    {
      return 1.0e25;
    }
    return propertyAc(Ug_ID)->scalarValueAt(e, coord, ip);
  } 
 
  virtual double waterDensity(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(Rhow_ID) == NULL)
    {
      return 0.0;
    }
    return propertyAc(Rhow_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double gasDensity(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(Rhog_ID) == NULL)
    {
      return 0.0;
    }
    return propertyAc(Rhog_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double residualWaterSaturation(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(SWR_ID) == NULL)
    {
      return 0.0;
    }
    return propertyAc(SWR_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double residualGasSaturation(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(SGR_ID) == NULL)
    {
      return 0.0;
    }
    return propertyAc(SGR_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double gasEntryPressure(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(Pd_ID) == NULL)
    {
      return 0.0;
    }
    return propertyAc(Pd_ID)->scalarValueAt(e, coord, ip);
  }
};
 
#endif