gmpChemicalFemPhysics.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_CHEMICAL_FEM_PHYSICS_H_
#define _GEMA_PLUGIN_CHEMICAL_FEM_PHYSICS_H_
 
#include "gmpChemicalConfig.h"
#include <gmpFemPhysicsCommon.h>
 
class GMP_CHEMICAL_FEM_PHYSICS_API_EXPORT GmpChemicalFemPhysics : public GmpFemPhysicsCommon
{
public:
  GmpChemicalFemPhysics(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmpChemicalFemPhysics();
 
  // Comments on the base class
  virtual const char* pluginName() const { return "ChemicalFemPhysics"; }
 
  virtual const QVariantMap* physicsMetaDataMap();
 
  virtual bool checkLoadedData();
 
  virtual FemResultType fillElementData(const GmElement* e, GmpFemMatrixSet& elemMatrices, GmpFemVectorSet& elemVectors);
  virtual FemResultType fillElementDataForBc(const GmElement* e, const GmBoundaryCondition* bc, int bcIndex, int bcListIndex,
                                             int border, GmpFemMatrixSet& elemMatrices, GmpFemVectorSet& elemVectors);
 
  virtual bool fixedNodalDofsBc(QVector<int>& nodes, QVector<int>&dof, QVector<double>& values, bool* constantValues) const;
 
  virtual bool fillFixedNodalDofsBCAlkalinity(QVector<int>& nodes, QVector<int>&dof,QVector<double>& values, bool* constantValues) const;
  virtual bool fillFixedNodalDofsBCbasalt(QVector<int>& nodes, QVector<int>& dof, QVector<double>& values, bool* constantValues) const;
  virtual bool calcDerivedResults(bool nonLinearSolver);
 
protected:
 
  virtual bool reactionRate(const GmElement* e, const GmVector* ip, int ipIndex, const GmVector& N, 
                            const GmVector& C, double wtJ, GmVector& elemFe, GmMatrix& elemK, 
                            bool needsFe, bool needsK) = 0;
 
  enum PhysicsAttributeIds
  {
    ISOPARAMETRIC_ID,     
    MULTI_DISPERSION_ID,  
    MULTI_RETARDATION_ID, 
    ALKALINITY_ID,                
    BASALTRXN_ID,               
 
    // --- NO ADDING BELOW THIS LINE
    NUM_ATTRIBUTE_IDS,  
  };
 
  enum StateVarIds
  {
    C_ID,   
  };
  enum NodeAttributeIds
  {
 
    // ------    NO ADDING BELOW THIS LINE
    NUM_NA_IDS,  
  };
 
  enum GaussAttributeIds
  {
    V_GA_ID,    
 
 
        // --- NO ADDING BELOW THIS LINE
        NUM_GA_IDS, 
  };
 
  enum ElementPropertyIds
  {
    D_ID,          
    K_ID,          
    V_ID,          
    PHI_ID,        
    THICKNESS_ID,  
 
    // --- NO ADDING BELOW THIS LINE
    NUM_PROPERTY_IDS,  
  };
 
  enum BoundaryConditionIds
  {
    PRESCRIBED_C_BC_ID,    
    PRESCRIBED_FLUX_BC_ID, 
    PRESCRIBED_MIXED_BC_ID,
    PRESCRIBED_CN_BC_ID,   
 
    // --- NO ADDING BELOW THIS LINE
    NUM_BC_IDS,  
  };
 
  enum BoundaryConditionValueIds
  {     
    BC_C_ID,       
    BC_CN_ID,       
    BC_Q_ID,       
    BC_QDIR_ID,    
    BC_MX_ID,      
 
    // --- NO ADDING BELOW THIS LINE
    NUM_BCV_IDS,  
  };
 
  GmVector _data;  
  GmVector _Cglobal;  // Save concentration Phreeqc output;
 
private:
  void fillDispersionCoefficient(const GmElement* e, const GmVector& ipCoord, int ipIndex, int s, GmMatrix& D);
  void addSpeciesToElementMatrix(int s, const GmMatrix& speciesMat, GmMatrix& elemMat);
  void addSpeciesToElementVector(int s, const GmVector& speciesVec, GmVector& elemVec);
};
 
#endif