gmpMaterialInterfaceFlow.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_MATERIAL_INTERFACEFLOW_H_
#define _GEMA_PLUGIN_HYDRAULIC_MATERIAL_INTERFACEFLOW_H_
 
#include <gmpFemPhysicsCommonMaterial.h>
 
#include "gmpHydraulicConfig.h"
#include "gmpHydraulicInterface.h"
 
class GMP_HYDRAULIC_PHYSICS_API_EXPORT GmpMaterialInterfaceFlow: public GmpFemPhysicsCommonMaterial
{
protected:
  enum InterfacePropertyIds
  {
    GAP_ID,               
    Uf_ID,                
    MFw_ID,               
    LKT_ID,               
    LKB_ID,               
    IOPEN_ID,             
 
    // --- NO ADDING BELOW THIS LINE
    NUM_PROPERTY_IDS,  
  };
 
public:
  enum InterfaceGaussAttributeIds
  {
    An_GA_ID,             
    AnOLD_GA_ID,
 
    // --- NO ADDING BELOW THIS LINE
    NUM_GA_IDS,  
  };
 
  GmpMaterialInterfaceFlow(int typeIndex, QString typeName, const GmLogCategory& logger)
    : GmpFemPhysicsCommonMaterial(typeIndex, typeName, logger) {}
 
  // set interface flow material map
  virtual const QVariantMap* materialMetaDataMap();
 
  // See comments on the base class
  virtual bool addStateItemsToGroup(GmStateDump* state, GmElementMesh* mesh, bool fixedHint, int groupId);
 
  virtual double fractureOpening(const GmElement* e, const GmVector* coord, int ip) const
  {
    S_TRACE();
    assert(e);
    return propertyAc(GAP_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double fluidViscosity(const GmElement* e, const GmVector* coord, int ip) const
  {
    S_TRACE();
    assert(e);
    return propertyAc(Uf_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double interfaceBiotModulus(const GmElement* e, const GmVector* coord, int ip) const
  {
    S_TRACE();
    assert(e);
    if (propertyAc(MFw_ID) == NULL)
    {
      return 0;
    }
    return propertyAc(MFw_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double leakoffTop(const GmElement* e, const GmVector* coord, int ip) const
  {
    S_TRACE();
    assert(e);
    if (propertyAc(LKT_ID) == NULL)
    {
      return 0;
    }
    return propertyAc(LKT_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double leakoffBottom(const GmElement* e, const GmVector* coord, int ip) const
  {
    S_TRACE();
    assert(e);
    if (propertyAc(LKB_ID) == NULL)
    {
      return 0;
    }
    return propertyAc(LKB_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual double initiallyOpenElem(const GmElement* e, const GmVector* coord, int ip) const
  {
    S_TRACE();
    assert(e);
    if (propertyAc(IOPEN_ID) == NULL)
    {
      return 1;
    }
    return propertyAc(IOPEN_ID)->scalarValueAt(e, coord, ip);
  }
 
  virtual bool initialCondition(const GmElement* e, const GmVector* coord, int ip) const;
 
  virtual void hydraulicConstitutiveModel(const GmElement* e, GmVector& flowParam, const GmVector* coord, int ip) const = 0;
 
};
 
#endif