ElementSubRegionBase.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_MESH_ELEMENTSUBREGIONBASE_HPP_
#define GEOSX_MESH_ELEMENTSUBREGIONBASE_HPP_

#include "managers/ObjectManagerBase.hpp"
namespace geosx
{

class NodeManager;
class FaceManager;
class MeshLevel;
class DomainPartition;
namespace constitutive
{
class ConstitutiveBase;
}

class ElementSubRegionBase : public ObjectManagerBase
{
public:


  ElementSubRegionBase( string const & name, dataRepository::Group * const parent );

  ~ElementSubRegionBase();



  virtual void CalculateElementGeometricQuantities( NodeManager const & nodeManager,
                                                    FaceManager const & faceManager ) = 0;

  virtual void setupRelatedObjectsInRelations( MeshLevel const * const mesh ) = 0;

  virtual void FixUpDownMaps( bool const clearIfUnmapped ) { GEOSX_UNUSED_VAR( clearIfUnmapped ); }



  localIndex const & numNodesPerElement() const { return m_numNodesPerElement; }

  virtual localIndex numNodesPerElement( localIndex const k ) const { GEOSX_UNUSED_VAR( k ); return m_numNodesPerElement; }

  void setNumNodesPerElement( localIndex numNodes )
  {
    m_numNodesPerElement = numNodes;
  }

  localIndex const & numIndependentNodesPerElement() const { return m_numIndependentNodesPerElement; }

  void setNumIndependentNodesPerElement( localIndex const numNodes )
  {
    m_numIndependentNodesPerElement = numNodes;
  }

  localIndex const & numEdgesPerElement() const { return m_numEdgesPerElement; }

  void setNumEdgesPerElement( localIndex const numEdges )
  {
    m_numEdgesPerElement = numEdges;
  }

  localIndex const & numFacesPerElement() const { return m_numFacesPerElement; }

  void setNumFacesPerElement( localIndex const numFaces )
  { m_numFacesPerElement = numFaces; }

  arrayView2d< real64 const > getElementCenter() const
  { return m_elementCenter; }

  arrayView2d< real64 > getElementCenter()
  { return m_elementCenter; }

  arrayView1d< real64 const > getElementVolume() const
  { return m_elementVolume; }

  dataRepository::Group const * GetConstitutiveModels() const
  { return &m_constitutiveModels; }

  dataRepository::Group * GetConstitutiveModels()
  { return &m_constitutiveModels; }

  template< typename T = constitutive::ConstitutiveBase >
  T const * getConstitutiveModel( string const & name ) const
  {
    return m_constitutiveModels.GetGroup< T >( name );
  }

  template< typename T = constitutive::ConstitutiveBase >
  T * getConstitutiveModel( string const & name )
  {
    return m_constitutiveModels.GetGroup< T >( name );
  }


  virtual string GetElementTypeString() const { return m_elementTypeString; }

  virtual void SetElementType( string const & elementType );

  std::vector< int > getVTKNodeOrdering() const;


  struct viewKeyStruct : ObjectManagerBase::viewKeyStruct
  {

    static constexpr auto numNodesPerElementString = "numNodesPerElement";
    static constexpr auto nodeListString           = "nodeList";
    static constexpr auto numEdgesPerElementString = "numEdgesPerElement";
    static constexpr auto edgeListString           = "edgeList";
    static constexpr auto numFacesPerElementString = "numFacesPerElement";
    static constexpr auto faceListString           = "faceList";
    static constexpr auto elementCenterString      = "elementCenter";
    static constexpr auto elementVolumeString      = "elementVolume";
  };

  struct groupKeyStruct : public ObjectManagerBase::groupKeyStruct
  {
    static constexpr auto constitutiveModelsString = "ConstitutiveModels";
  };

private:
  dataRepository::Group m_constitutiveModels;

protected:
  localIndex m_numNodesPerElement;

  localIndex m_numIndependentNodesPerElement;

  localIndex m_numEdgesPerElement;

  localIndex m_numFacesPerElement;

  array2d< real64 > m_elementCenter;

  array1d< real64 > m_elementVolume;

  string m_elementTypeString;

};


} /* namespace geosx */

#endif /* GEOSX_MESH_ELEMENTSUBREGIONBASE_HPP_ */