gmpHydraulicInterfaceTwoPhaseFlow.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_INTERFACE_TWOPHASEFLOW_H_
#define _GEMA_PLUGIN_HYDRAULIC_INTERFACE_TWOPHASEFLOW_H_
 
#include "gmpHydraulicTwoPhaseUtils.h"
#include "gmpHydraulicInterface.h"
 
#include <gmpFemPhysicsCommon.h>
#include <gmTrace.h>
 
class GmGaussAccessor;
 
namespace tp = GmpHydraulicTwoPhaseUtils;
 
class GmpHydraulicInterfaceTwoPhaseFlow : public GmpHydraulicInterface
{
public:
  // constructor
        GmpHydraulicInterfaceTwoPhaseFlow(const char* pluginType, GmSimulationData* simulation, QString id, QString description,
                        const GmpFemPhysicsCommonMaterialFactory* matFactory, const GmLogCategory& logger);
 
  // destructor
  virtual ~GmpHydraulicInterfaceTwoPhaseFlow();
  
  // set physic map
  virtual const QVariantMap* physicsMetaDataMap();
  // Comments on the base class
  virtual bool checkAndLoadAttributeAccessors(LuaTable& nodeTable, LuaTable& cellTable, LuaTable& gaussTable);
  virtual bool beforeElementStiffnessLoop(const GmpFemMatrixSet& elemMatrices, const 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 GmpFemPhysics::FemResultType fillElementData(const GmElement* e, GmpFemMatrixSet& elemMatrices, GmpFemVectorSet& elemVectors);
 
  // See comments on the base class
  virtual bool addStateItemsToGroup(GmStateDump* state, bool fixedHint, int groupId);
 
  virtual bool computeInitialNodalAttributes();
  virtual bool computeNodalAttributes();
 
  virtual void FillDofIndexPosition(const GmElement* e, QVector<int>& iPe, QVector<int>& iPfe) const;
 
  virtual bool setInitialConditions() const;
 
  virtual void fillElementOldLiqPorePressure(const GmElement* e, GmVector& plOld) const;
 
  virtual void fillElementGasPorePressure(const GmElement* e, GmVector& pg) const;
 
  virtual void fillElementOldGasPorePressure(const GmElement* e, GmVector& pgOld) const;
 
  virtual void fillDofMappingMatrices(const GmElement* e, GmMatrix& Hb, GmMatrix& Ht, GmMatrix& Hm) const;
  
  virtual bool evaluateNodalVariables(const GmElement* e, GmMatrix& midSurfMap, tp::saturationTerms& Sat,
    tp::densityTerms& Den, tp::viscosityTerms& Mu, tp::massTerms& Ms, tp::pressureTerms& Pres);
 
  virtual bool transversalAdvectiveFluxMatrix(const GmElement* e, GmMatrix& Ht, GmVector& Np,
      GmMatrix& botSurfMap, GmMatrix& topSurfMap, GmMatrix& midSurfMap, const int nDof, double c) const;
 
  virtual bool addMassStorage(GmVector& fil, GmVector& fig, tp::jacobianTerms& J, GmMatrix& midSurfMap,
      GmVector& iNp, tp::massTerms& mass, double dt);
 
  virtual bool addAdvectiveFlux(GmVector& fil, GmVector& fig, tp::jacobianTerms& J, GmMatrix& H, GmVector& fgravp,
      tp::densityTerms& den, tp::viscosityTerms& mu, tp::permeabilityTerms& kr, tp::pressureTerms& pres, bool needsGrav);
 
  virtual bool assembleElementData(const GmElement* e, GmMatrix& J, GmVector& r, GmVector& Fil, GmVector& Fig,
    tp::jacobianTerms& K, QVector<int>& iPl, QVector<int>& iPg);
 
protected:
  
   virtual const GmElementDof* dofMapping(GmCellType type) const;
 
   enum TwoPhaseStateVarIds
   {
           PG_ID = GmpHydraulic::NUM_STATEVAR_IDS, 
 
           // --- NO ADDING BELOW THIS LINE
           NUM_STATEVAR_IDS,  
   };
 
   enum TwoPhasePhysicsAttributeIds
   {
     COMPUTENODALATTRS_ID = GmpHydraulicInterface::NUM_ATTRI_IDS,        
 
 
     // ------         NO ADDING BELOW THIS LINE
     NUM_ATTRI_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