gmpChemicalInterface.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_INTERFACE_H_
#define _GEMA_PLUGIN_CHEMICAL_INTERFACE_H_
 
 
#include <gmpFemPhysicsCommon.h>
#include <gmpFemPhysicsCommonMaterial.h>
#include "gmpChemicalFemPhysics.h"
#include <gmGaussAccessor.h>
#include <gmTrace.h>
 
class GmGaussAccessor;
 
 
class GmpChemicalInterface : public GmpChemicalFemPhysics
{
public:
  // constructor
        GmpChemicalInterface(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
 
  // destructor
  virtual ~GmpChemicalInterface();
 
  enum InterfacePropertyIds
  {
    IOPEN_ID = GmpChemicalFemPhysics::NUM_PROPERTY_IDS,  
    An_ID,
 
    // --- NO ADDING BELOW THIS LINE
    NUM_PROPER_IDS,  
  };
 
  enum InterfaceGaussAttributeIds
  {
    An_GA_ID = GmpChemicalFemPhysics::NUM_GA_IDS, 
    AnOLD_GA_ID,
 
    // --- NO ADDING BELOW THIS LINE
    NUM_GA_IDS,  
  };
 
  virtual const QVariantMap* physicsMetaDataMap();
 
  // Comments on the base class
  virtual const char* pluginType() const { return "interface"; }
 
  virtual 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 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 calcDerivedResults(bool nonLinearSolver);
 
  virtual void fillStorageCompMatrix(const GmElement* e, const GmVector* coord, int ip, GmMatrix& Sc, const GmVector& N, 
          double phi, double k, double c) const;
 
  virtual void fillDiffusionMatrix(const GmElement* e, GmMatrix& Kc, const GmMatrix& Bp, const GmMatrix& D, const GmVector& v, 
          const GmVector& N, double phi, double c, int ns);
 
  //virtual bool setInitialGaussAttributes(const GmElement* e, const GmVector* coord, int ip) const;
 
  virtual bool setInitialConditions() const;
  virtual void fillElementConcentration(const GmElement* e, GmVector& pe);
 
  virtual double initiallyOpenElem(const GmElement* e, const GmVector* coord, int ip) const
  {
    S_TRACE();
    assert(e); 
    GmCellAccessor* iOpenAcc = propertyAc(IOPEN_ID);
    if (iOpenAcc == NULL)
    {
      return 1.0;
    }
    return iOpenAcc->scalarValueAt(e, coord, ip);
  }
 
  enum BoundaryConditionIds
  {
    FIXED_C_BC_INT_ID = GmpChemicalFemPhysics::NUM_BC_IDS, 
    FIXED_CF_BC_INT_ID,   
    //PRESCRIBED_MIXED_BC_INT_ID, //!< Id for third kind boundary condition on cell
  };
 
  enum BoundaryConditionValueIds
  {
    BC_C_INT_ID = GmpChemicalFemPhysics::NUM_BCV_IDS,  
    BC_Q_INT_ID,        
    //BC_MX_VAL_ID,     //!< Third Kind Boundary Condition. Robin/Cauchy. 
    BC_C_POS_ID,        
    BC_Q_POS_ID,        
    //BC_MX_INT_ID,      //!< BC Id for node on cell where is prescribed the thrid kind boundary condition.
  };
protected:
  virtual const GmElementDof* dofMapping(GmCellType type) const;
 
  void fillMiddleCoordinates(const GmElement* e, const GmMatrix& Xnode, GmMatrix& MX) const;
 
  // Computes the chemical reaction
  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);
};
 
#endif