GEOSX
EmbeddedSurfaceRegion.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
7  * Copyright (c) 2018-2020 Total, S.A
8  * Copyright (c) 2019- GEOSX Contributors
9  * All rights reserved
10  *
11  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
12  * ------------------------------------------------------------------------------------------------------------
13  */
14 
20 #ifndef GEOSX_MESH_EMBEDDEDSURFACEREGION_HPP_
21 #define GEOSX_MESH_EMBEDDEDSURFACEREGION_HPP_
22 
23 #include "ElementRegionBase.hpp"
24 
25 namespace geosx
26 {
27 
28 class EdgeManager;
29 
38 {
39 public:
40 
44 
51  EmbeddedSurfaceRegion( string const & name, Group * const parent );
52 
56  EmbeddedSurfaceRegion() = delete;
57 
61  virtual ~EmbeddedSurfaceRegion() override;
62 
64 
68 
74  static const string CatalogName()
75  { return "EmbeddedSurfaceElementRegion"; }
76 
77  virtual const string getCatalogName() const override final
79 
81 
85 
91  real64 getDefaultAperture() const { return m_defaultAperture; }
92 
94 
100  {
102  static constexpr auto fractureSetString = "fractureSet";
104  static constexpr auto defaultApertureString = "defaultAperture";
105  };
106 
107 protected:
108  virtual void InitializePreSubGroups( Group * const ) override;
109 
110 private:
111 
112  real64 m_defaultAperture;
113 
114 };
115 
116 } /* namespace geosx */
117 
118 #endif /* CORECOMPONENTS_MESH_EMBEDDEDSURFACEREGION_HPP_ */
static constexpr auto fractureSetString
Fracture set string.
A struct to serve as a container for variable strings and keys.
static constexpr auto defaultApertureString
Default fracture aperture.
virtual ~EmbeddedSurfaceRegion() override
Default destructor.
double real64
64-bit floating point type.
Definition: DataTypes.hpp:136
real64 getDefaultAperture() const
Get default aperture value.
virtual void InitializePreSubGroups(Group *const) override
Called by Initialize() prior to initializing sub-Groups.
The ElementRegionBase is the base class to manage the data stored at the element level.
static const string CatalogName()
Get the key name for the EmbeddedSurfaceRegion in the object catalog.
EmbeddedSurfaceRegion()=delete
Deleted default constructor.
virtual const string getCatalogName() const override final
Get the name of the catalog.
Struct to serve as a container for variable strings and keys.