gmpHydraulic.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_HYDRAULICS_H_
#define _GEMA_PLUGIN_HYDRAULICS_H_
 
 
#include "gmpHydraulicConfig.h"
 
#include <gmpFemPhysicsCommon.h>
#include <gmGaussAccessor.h>
#include <gmMathUtils.h>
 
class GmGaussAccessor;
 
class GMP_HYDRAULIC_PHYSICS_API_EXPORT GmpHydraulic : public GmpFemPhysicsCommon
{
public:
  enum HMaterialPointStates{
          saturated,
          unsaturated
  };
 
  struct HMaterialPointAccessors
  {
    GmGaussAccessor* newState;
    GmGaussAccessor* oldState;
  };
 
  // constructor
  GmpHydraulic(const char* pluginType, GmSimulationData* simulation, QString id, QString description,
                const GmpFemPhysicsCommonMaterialFactory* matFactory, const GmLogCategory& logger);
  // destructor
  virtual ~GmpHydraulic();
 
  // Comments on the base class
  virtual const char* pluginName() const { return "HydroFemPhysics"; }
 
  // Comments on the base class
  virtual const char* pluginType() const { return _pluginType; }
 
  virtual const QVariantMap* physicsMetaDataMap();
 
  // See comments on the base class
  //virtual bool checkLoadedData();
 
  // See comments on the base class
  //virtual bool addStateItemsToGroup(GmStateDump* state, bool fixedHint, int groupId);
 
  // \brief Tell the world that the hydraulic physics supports state dumping.
  virtual bool supportsStateDumping() { return true; }
  
  virtual 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;
  // Comments on the base class
  virtual FemResultType fillElementDataForBc(const GmElement* e, const GmBoundaryCondition* bc, int bcIndex, int bcListIndex,
                                             int border, GmpFemMatrixSet& elemMatrices, GmpFemVectorSet& elemVectors);
  virtual FemResultType fillElementDataBc(const GmElement* e, const GmBoundaryCondition* bc, int bcIndex, int bcListIndex,
                                          int border, GmMatrix& elemMat, GmVector& elemVec);
 
  virtual bool calcDerivedResults(bool nonLinearSolver);
 
  virtual void fillStorageCompMatrix(const GmElement* e, const GmVector* coord, int ip, GmMatrix& Sc, const GmVector& N, double c);
 
  virtual void fillFlowMatrix(const GmElement* e, const GmVector* coord, int ip, GmMatrix& Kc, const GmMatrix& Bp, double c) const;
 
  virtual void fillFluidVelocity(const GmElement* e, const GmVector* coord, int ip, GmVector& Vip, const GmVector& Pe, const GmMatrix& Bp) const;
 
 
  virtual void fillElementPorePressure(const GmElement* e, GmVector& pe);
 
  virtual void gravitySupplyFluid(const GmElement* e, const GmVector* coord, int ip, GmVector& qext_gsf, GmMatrix& Bp, double c);
 
  virtual void fillSourceTermVector(const GmElement* e, const GmVector* coord, int ip, GmVector& St, const GmVector& N, double c);
 
  virtual double fillBpMatrix(const GmShape* shape, const GmVector& ncoord, const GmMatrix& X, const GmVector& N, const GmMatrix& J, GmMatrix& Bp) = 0;
  
  virtual void gravityVector(const GmElement* e, const GmVector* coord, int ip, GmVector& grav) const;
 
  virtual bool isAxisymmetric() { return false; }
 
  virtual double axisymmetricFactor(const GmElement* e, const GmMatrix& X, const GmVector& N) const { Q_UNUSED(e); Q_UNUSED(X); Q_UNUSED(N); return 1.0; }
 
  HMaterialPointAccessors& hydraulicMaterialPoint(){ return _hmaterialPointAccessor; }
 
  enum PhysicsAttributeIds
  {
    ISOPARAMETRIC_ID,         
    POROSITY_UPDATE_ID,       
    PERMEABILITY_UPDATE_ID,   
    USE_CONSISTENT_MATRIX_ID, 
    VELOCITY_MODE_ID,         
    FLOW_MODE_ID,             
    DIRECT_ID,                
    CGRAV_ID,                 
    VF_MODE_ID,               
 
    // ------         NO ADDING BELOW THIS LINE
    NUM_ATTRI_IDS,    
  };
 
  enum StateVarIds
  {
    P_ID,   
 
    // --- NO ADDING BELOW THIS LINE
    NUM_STATEVAR_IDS,  
  };
 
  enum NodeAttributeIds
  {
    V_NA_ID,     
    Q_NA_ID,     
    VF_NA_ID,    
 
    // ------    NO ADDING BELOW THIS LINE
    NUM_NA_IDS,  
  };
 
  enum cellAttributeIds
  {
 
    // --- NO ADDING BELOW THIS LINE
    NUM_CA_IDS,  
  };
 
  enum GaussAttributeIds
  {
    V_GA_ID,     
    Q_GA_ID,     
    FT_GA_ID,    
    FTOLD_GA_ID, 
 
    // --- NO ADDING BELOW THIS LINE
    NUM_GA_IDS,  
  };
 
  enum ElementPropertyIds
  {
    THICKNESS_ID,  
    GRAV_ID,       
    SOURTERM_ID,    
 
    // --- NO ADDING BELOW THIS LINE
    NUM_PROPER_IDS,  
  };
 
  enum BoundaryConditionIds
  {
    FIXED_P_BC_ID,  
    FIXED_Q_BC_ID,  
    FIXED_SPF_BC_ID, 
 
    // --- NO ADDING BELOW THIS LINE
    NUM_BC_IDS,  
  };
 
  enum BoundaryConditionValueIds
  {
    BC_P_ID,      
    BC_QW_ID,     
    BC_IF_ID,     
 
    // --- NO ADDING BELOW THIS LINE
    NUM_BCV_IDS,  
  };
 
protected:
  virtual bool checkAndLoadAttributeAccessors(LuaTable& nodeTable, LuaTable& cellTable, LuaTable& gaussTable);
  virtual void calcElementDerivedResultAtPoints(const GmElement* e, int resultId, const GmMatrix& evalPoints, bool evalAtIp, GmMatrix& result);
  void calcElementVelocityAtPoints(const GmElement* e, const GmMatrix& evalPoints, GmMatrix& v);
  void calcElementFlowAtPoints    (const GmElement* e, const GmMatrix& evalPoints, bool evalAtIp, GmMatrix& q);
 
  HMaterialPointAccessors  _hmaterialPointAccessor;             
  bool                     _setInitialCond;           
 
private:
  const char* _pluginType;     
  
};
 
#endif