gmpHydraulicMaterialTwoPhase.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_TWOPHASE_H_
#define _GEMA_PLUGIN_HYDRAULIC_MATERIAL_TWOPHASE_H_
 
#include "gmpMaterialSaturated.h"
 
class GMP_HYDRAULIC_PHYSICS_API_EXPORT GmpHydraulicMaterialTwoPhase: public GmpFemPhysicsCommonMaterial
{
protected:
  enum TwoPhasePropertyIds
  {
 
    K_ID ,           
    Pht_ID,          
    Bp_ID,           
    RPMIN_ID,        
    // Liquid Properties
    Kww_ID,          
    Uw_ID,           
    Rhow_ID,         
    LAMBDAL_ID,      
    LRP_ID,          
    SLR_ID,                      
    KRLCURVE_ID,     
    LIQRHO_ID,       
    // Gas properties
    Kgg_ID,          
    Ug_ID,           
    Rhog_ID,         
    LAMBDAG_ID,      
    GRP_ID,          
    SGR_ID,                      
    KRGCURVE_ID,     
    GASRHO_ID,       
    //
    R_ID,            
    T_ID,            
    Mg_ID,           
    // saturation Law
    Pd_ID,                           
    LAMBDA_ID,       
    SATLAW_ID,       
    PCSLCURVE_ID,    
    
 
    // --- NO ADDING BELOW THIS LINE
    NUM_PROPERTY_IDS,  
  };
 
public:
 
  GmpHydraulicMaterialTwoPhase(int typeIndex, QString typeName, const GmLogCategory& logger)
    : GmpFemPhysicsCommonMaterial(typeIndex, typeName, logger) {}
 
  static GmpFemPhysicsCommonMaterial* instance(GmSimulationData* simulation, int typeIndex, QString typeName, const GmLogCategory& logger)
  {
      Q_UNUSED(simulation);
      return new GmpHydraulicMaterialTwoPhase(typeIndex, typeName, logger);
  }
 
  // Sets multiPhase material map
  virtual const QVariantMap* materialMetaDataMap();
 
  // Checks material loaded data.
  bool checkLoadedData(const GmElement* e) const;
 
  enum twoPhaseRelationships
  {
      BrooksCorey,
      vanGenuchten,
      UMAT,
      Liakopoulos,
 
      // ------    NO ADDING BELOW THIS LINE
      NUM_TWOPHASEREL_IDS,          
  };
 
  enum fluidDensityModel
  {
      constant,
          exponential,
      linear,
      idealGas,
      superCriticalCO2,
 
      // ------    NO ADDING BELOW THIS LINE
      NUM_FLUIDDENSITY_IDS,          
  };
 
  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 liquidDensity(const GmElement* e, const GmVector* coord, int ip, const double Plref = 0.0, double Pl = 0.0) const;
 
  virtual double liquidDensityPressureCompressibility(const GmElement* e, const GmVector* coord, int ip, double rho) const;
 
  virtual double gasDensity(const GmElement* e, const GmVector* coord, int ip, const double Pgref = 0.0, double Pg = 0.0) const;
 
  virtual double exponentialFluidDensity(const double rho0, const double K, const double P0, const double P) const;
 
  virtual double exponentialFluidDensityCompressibility(const double rho, const double K) const;
 
  virtual double linearFluidDensity(const double rho0, const double K, const double P0, const double P) const;
 
  virtual double linearFluidDensityCompressibility(const double rho0, const double K) const;
 
  virtual double gasDensityPressureCompressibility(const GmElement* e, const GmVector* coord, int ip, double rho) const;
 
  virtual double idealGasDensity(const GmElement* e, const GmVector* coord, int ip, double Pg) const;
 
  virtual double idealGasCompressibility(const GmElement* e, const GmVector* coord, int ip) const;
 
  virtual double liquidSaturation(const GmElement* e, const GmVector* coord, int ip, double pc) const;
  
  virtual double derivativeLiquidSaturation(const GmElement* e, const GmVector* coord, int ip, double Sl, double Pc = 0.0) const;
 
  virtual double derivativeEffectiveSaturationDegree(const GmElement* e, const GmVector* coord, int ip) const;
 
  virtual double derivativeLiquidRelativePermeability(const GmElement* e, const GmVector* coord, int ip, double Sl) const;
 
  virtual double derivativeGasRelativePermeability(const GmElement* e, const GmVector* coord, int ip, double Sl) const;
 
  virtual double effectiveSaturation(const GmElement* e, const GmVector* coord, int ip, double Sw) const;
  
  virtual double liquidRelativePermeability(const GmElement* e, const GmVector* coord, int ip, double Sw) const;
 
  virtual double gasRelativePermeability(const GmElement* e, const GmVector* coord, int ip, double Sw) const;
 
  virtual int saturationLawId(const GmElement* e, const GmVector* coord, int ip) const
  {
      S_TRACE(); assert(e);
      GmCellAccessor* SatLawAcc = propertyAc(SATLAW_ID);
      if (SatLawAcc == NULL)
      {
          return 0;
      }
      return SatLawAcc->scalarValueAt(e, coord, ip);
  }
 
  virtual int liquidRelativePermeabilityId(const GmElement* e, const GmVector* coord, int ip) const
  {
      S_TRACE(); assert(e);
      GmCellAccessor* LiqRelAcc = propertyAc(LRP_ID);
      if (LiqRelAcc == NULL)
      {
          return 0;
      }
      return LiqRelAcc->scalarValueAt(e, coord, ip);
  }
 
  virtual int gasRelativePermeabilityId(const GmElement* e, const GmVector* coord, int ip) const
  {
      S_TRACE(); assert(e);
      GmCellAccessor* GasRelAcc = propertyAc(GRP_ID);
      if (GasRelAcc == NULL)
      {
          return 0;
      }
      return GasRelAcc->scalarValueAt(e, coord, ip);
  }
 
  virtual int liquidDensityModelId(const GmElement* e, const GmVector* coord, int ip) const
  {
          S_TRACE(); assert(e);
          GmCellAccessor* FluidRhoAcc = propertyAc(LIQRHO_ID);
          if (FluidRhoAcc == NULL)
          {
                  return 0;  // Constant density
          }
          return FluidRhoAcc->scalarValueAt(e, coord, ip);
  }
 
  virtual int gasDensityModelId(const GmElement* e, const GmVector* coord, int ip) const
  {
      S_TRACE(); assert(e);
      GmCellAccessor* FluidRhoAcc = propertyAc(GASRHO_ID);
      if (FluidRhoAcc == NULL)
      {
          return 0;  // Constant density
      }
      return FluidRhoAcc->scalarValueAt(e, coord, ip);
  }
 
  virtual double intrinsicPermeability(const GmElement* e, const GmVector* coord, int ip) const
  {
      return propertyAc(K_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual bool checkIntrinsicPermeability(const GmElement* e, const GmVector* coord, int ip) const
  {
      S_TRACE(); assert(e);
      // Check is element is an interface element
      bool isInterface = e->geometry().isInterface();
      if ((propertyAc(K_ID) == NULL) && (!isInterface))
      {
          return false;
      }
      return true;
  }
  
  virtual double porosity(const GmElement* e, const GmVector* coord, int ip) const
  {
    return propertyAc(Pht_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual bool checkPorosity(const GmElement* e, const GmVector* coord, int ip) const
  {
      S_TRACE(); assert(e);
      // Check is element is an interface element
      bool isInterface = e->geometry().isInterface();
      if ((propertyAc(Pht_ID) == NULL) && (!isInterface))
      {
          return false;
      }
      return true;
  }
 
  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 molarMassGas(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 liquidBulkModulus(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 liquidReferencePressure(const GmElement* e, const GmVector* coord, int ip) const
  {
          return 0.0;
  }
 
  virtual double gasReferencePressure(const GmElement* e, const GmVector* coord, int ip) const
  {
      return 0.0;
  }
 
  virtual double liquidViscosity(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 liqReferenceDensity(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 gasReferenceDensity(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 residualLiquidSaturation(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(SLR_ID) == NULL)
    {
      return 0.0;
    }
    return propertyAc(SLR_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);
  }
 
  virtual double liquidPermeabilityFittingParameter(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(LAMBDAL_ID) == NULL)
    {
      return 0.0;
    }
    return propertyAc(LAMBDAL_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double gasPermeabilityFittingParameter(const GmElement* e, const GmVector* coord, int ip) const
  {
    if (propertyAc(LAMBDAG_ID) == NULL)
    {
      return 0.0;
    }
    return propertyAc(LAMBDAG_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double saturationFittingParameter(const GmElement* e, const GmVector* coord, int ip) const
  {
      if (propertyAc(LAMBDA_ID) == NULL)
      {
          return 0.0;
      }
      return propertyAc(LAMBDA_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double minimumRelativePermeability(const GmElement* e, const GmVector* coord, int ip) const
  {
      if (propertyAc(RPMIN_ID) == NULL)
      {
          return 1.0e-5;
      }
      return propertyAc(RPMIN_ID)->scalarValueAt(e, coord, ip);
  }
};
 
#endif