gmpHydraulicTwoPhaseFlow.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_TWOPHASEFLOW_H_
#define _GEMA_PLUGIN_HYDRAULIC_TWOPHASEFLOW_H_
 
#include "gmpHydraulicTwoPhaseUtils.h"
#include "gmpHydraulic.h"
 
#include <gmpFemPhysicsCommon.h>
#include <gmMathUtils.h>
#include <gmTrace.h>
 
class GmGaussAccessor;
 
namespace tp = GmpHydraulicTwoPhaseUtils;
 
class GMP_HYDRAULIC_PHYSICS_API_EXPORT GmpHydraulicTwoPhaseFlow : public GmpHydraulic
{
public:
  // constructor
  GmpHydraulicTwoPhaseFlow(const char* pluginType, GmSimulationData* simulation, QString id, QString description,
                             const GmpFemPhysicsCommonMaterialFactory* matFactory, const GmLogCategory& logger);
  // destructor
  virtual ~GmpHydraulicTwoPhaseFlow();
 
  // set physic map
  virtual const QVariantMap* physicsMetaDataMap();
 
  // Comments on the base class
  bool checkAndLoadAttributeAccessors(LuaTable& nodeTable, LuaTable& cellTable, LuaTable& gaussTable);
  virtual bool beforeElementStiffnessLoop(const GmpFemMatrixSet& elemMatrices, const GmpFemVectorSet& elemVectors);
  
  virtual GmpFemPhysics::FemResultType fillElementData(const GmElement* e, GmpFemMatrixSet& elemMatrices, GmpFemVectorSet& elemVectors);
 
  virtual bool fixedNodalForcesBc(QVector<int>& nodes, QVector<int>&dof, QVector<double>& values) const;
 
  virtual bool fixedNodalDofsBc  (QVector<int>& nodes, QVector<int>&dof, QVector<double>& values, bool* constantValues) const;
 
  virtual bool setInitialConditions();
  virtual bool setInitialPorosity() const;
  virtual bool computeInitialNodalAttributes();
  virtual bool computeNodalAttributes();
  virtual void gravityVector(const GmElement* e, const GmVector* coord, int ip, GmVector& grav) const;
 
  // See comments on the base class
  virtual bool calcDerivedResults(bool nonLinearSolver);
  // Evaluates the hydraulic permeability matrix for each ip
  virtual void evaluatePermeabilityMatrix(const GmElement* e, GmMatrix& Kh, GmMatrix& H, GmMatrix& Bp,
    const GmVector* coord, int ip, double c) const;
 
  virtual void fillElementGasPorePressure(const GmElement* e, GmVector& Pce) const;
 
  virtual void fillElementOldGasPorePressure(const GmElement* e, GmVector& pgOld) const;
 
  virtual void fillElementOldLiqPorePressure(const GmElement* e, GmVector& plOld) const;
 
  virtual void fillElementPorePressureIncrement(const GmElement* e, GmVector& P, GmVector& dP) const;
 
  virtual void fillElementPerturbedPorePressure(const GmElement* e, const GmVector& P, const GmVector& eps, GmVector& Pl, GmVector& Pg) const;
 
  virtual void FillDofIndexPosition(const GmElement* e, QVector<int>& iPe, QVector<int>& iPfe) const;
 
  // Evaluates nodal variables
  virtual bool evaluateNodalVariables(const GmElement* e, tp::saturationTerms& Sat, tp::densityTerms& Den,
               tp::viscosityTerms& Mu, tp::massTerms& Ms, tp::pressureTerms& Pres);
 
  virtual bool assembleElementData(const GmElement* e, GmMatrix& J, GmVector& r, GmVector& Fil, GmVector& Fig,
    tp::jacobianTerms& K, QVector<int>& iPl, QVector<int>& iPg);
 
protected:
  // See comments on the base class
  virtual const GmElementDof* dofMapping(GmCellType type) const;
 
 
  enum TwoPhaseStateVarIds
  {
    PG_ID = GmpHydraulic::NUM_STATEVAR_IDS, 
 
    // --- NO ADDING BELOW THIS LINE
    NUM_STATEVAR_IDS,  
  };
 
  enum TwoPhaseNodeAttributeIds
  {
    Pl_NA_ID = GmpHydraulic::NUM_NA_IDS,   
    PlOLD_NA_ID,                           
    Pg_NA_ID,                              
    PgOLD_NA_ID,                           
    RHOl_NA_ID,                            
    RHOlOLD_NA_ID,                         
    RHOg_NA_ID,                            
    RHOgOLD_NA_ID,                         
    PlRef_NA_ID,                           
    PgRef_NA_ID,                           
 
    // ------     NO ADDING BELOW THIS LINE
    NUM_NA_IDS,  
  };
 
  enum TwoPhaseCellAttributeIds
  {
    Sl_CA_ID = GmpHydraulic::NUM_CA_IDS, 
    POR_CA_ID,       
    POROLD_CA_ID,    
 
    // ------    NO ADDING BELOW THIS LINE
    NUM_CA_IDS,  
  };
 
  enum TwoPhaseBoundaryConditionIds
  {
    FIXED_PG_BC_ID = GmpHydraulic::NUM_BC_IDS, 
    FIXED_QG_BC_ID,                            
 
    // --- NO ADDING BELOW THIS LINE
    NUM_BC_IDS,  
  };
 
  enum TwoPhaseBoundaryConditionValueIds
  {
    BC_PG_ID = GmpHydraulic::NUM_BCV_IDS,  
    BC_QG_ID,                             
 
    // --- NO ADDING BELOW THIS LINE
    NUM_BCV_IDS,  
  };
//public:
 
};
 
#endif