https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
SphereSurfaceMeshGenerator Class Reference

Create a sphere surface mesh based on the recursive subdivision of the faces of a regular icosahedron. More...

#include <SphereSurfaceMeshGenerator.h>

Inheritance diagram for SphereSurfaceMeshGenerator:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 SphereSurfaceMeshGenerator (const InputParameters &parameters)
 
std::unique_ptr< MeshBase > generate () override
 
std::unique_ptr< MeshBase > generateInternal ()
 
const std::set< MeshGeneratorName > & getRequestedMeshGenerators () const
 
const std::set< MeshGeneratorName > & getRequestedMeshGeneratorsForSub () const
 
void addParentMeshGenerator (const MeshGenerator &mg, const AddParentChildKey)
 
void addChildMeshGenerator (const MeshGenerator &mg, const AddParentChildKey)
 
const std::set< const MeshGenerator *, Comparator > & getParentMeshGenerators () const
 
const std::set< const MeshGenerator *, Comparator > & getChildMeshGenerators () const
 
const std::set< const MeshGenerator *, Comparator > & getSubMeshGenerators () const
 
bool isParentMeshGenerator (const MeshGeneratorName &name, const bool direct=true) const
 
bool isChildMeshGenerator (const MeshGeneratorName &name, const bool direct=true) const
 
bool isNullMeshName (const MeshGeneratorName &name) const
 
bool hasSaveMesh () const
 
bool hasOutput () const
 
const std::string & getSavedMeshName () const
 
bool hasGenerateData () const
 
bool isDataOnly () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static bool hasGenerateData (const InputParameters &params)
 
static void setHasGenerateData (InputParameters &params)
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static const std::string data_only_param
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void generateData ()
 
T & copyMeshProperty (const std::string &target_data_name, const std::string &source_data_name, const std::string &source_mesh)
 
T & copyMeshProperty (const std::string &source_data_name, const std::string &source_mesh)
 
std::unique_ptr< MeshBase > & getMesh (const std::string &param_name, const bool allow_invalid=false)
 
std::vector< std::unique_ptr< MeshBase > *> getMeshes (const std::string &param_name)
 
std::unique_ptr< MeshBase > & getMeshByName (const MeshGeneratorName &mesh_generator_name)
 
std::vector< std::unique_ptr< MeshBase > *> getMeshesByName (const std::vector< MeshGeneratorName > &mesh_generator_names)
 
void declareMeshForSub (const std::string &param_name)
 
void declareMeshesForSub (const std::string &param_name)
 
void declareMeshForSubByName (const MeshGeneratorName &mesh_generator_name)
 
void declareMeshesForSubByName (const std::vector< MeshGeneratorName > &mesh_generator_names)
 
std::unique_ptr< MeshBase > buildMeshBaseObject (unsigned int dim=libMesh::invalid_uint)
 
std::unique_ptr< ReplicatedMesh > buildReplicatedMesh (unsigned int dim=libMesh::invalid_uint)
 
std::unique_ptr< DistributedMesh > buildDistributedMesh (unsigned int dim=libMesh::invalid_uint)
 
void addMeshSubgenerator (const std::string &type, const std::string &name, Ts... extra_input_parameters)
 
void addMeshSubgenerator (const std::string &type, const std::string &name, InputParameters params)
 
void declareNullMeshName (const MeshGeneratorName &name)
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
T & declareMeshProperty (const std::string &data_name, Args &&... args)
 
T & declareMeshProperty (const std::string &data_name, const T &data_value)
 
T & declareMeshProperty (const std::string &data_name, Args &&... args)
 
T & declareMeshProperty (const std::string &data_name, const T &data_value)
 
T & setMeshProperty (const std::string &data_name, Args &&... args)
 
T & setMeshProperty (const std::string &data_name, const T &data_value)
 
T & setMeshProperty (const std::string &data_name, Args &&... args)
 
T & setMeshProperty (const std::string &data_name, const T &data_value)
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

const Real _radius
 sphere radius More...
 
const Point _center
 
const unsigned int _depth
 recursion levels for triangle subdivision More...
 
MooseMesh *const _mesh
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
const Parallel::Communicator & _communicator
 

Detailed Description

Create a sphere surface mesh based on the recursive subdivision of the faces of a regular icosahedron.

Definition at line 19 of file SphereSurfaceMeshGenerator.h.

Constructor & Destructor Documentation

◆ SphereSurfaceMeshGenerator()

SphereSurfaceMeshGenerator::SphereSurfaceMeshGenerator ( const InputParameters &  parameters)

Definition at line 36 of file SphereSurfaceMeshGenerator.C.

37  : MeshGenerator(parameters),
38  _radius(getParam<Real>("radius")),
39  _center(getParam<Point>("center")),
40  _depth(getParam<unsigned int>("depth"))
41 {
42 }
MeshGenerator::MeshGenerator
MeshGenerator(const InputParameters &parameters)
SphereSurfaceMeshGenerator::_radius
const Real _radius
sphere radius
Definition: SphereSurfaceMeshGenerator.h:30
MeshGenerator::parameters
const InputParameters & parameters() const
SphereSurfaceMeshGenerator::_depth
const unsigned int _depth
recursion levels for triangle subdivision
Definition: SphereSurfaceMeshGenerator.h:36

Member Function Documentation

◆ generate()

std::unique_ptr< MeshBase > SphereSurfaceMeshGenerator::generate ( )
overridevirtual

Implements MeshGenerator.

Definition at line 45 of file SphereSurfaceMeshGenerator.C.

46 {
47  // Have MOOSE construct the correct libMesh::Mesh object using Mesh block and CLI parameters.
48  auto mesh = buildMeshBaseObject();
49  mesh->set_mesh_dimension(2);
50  mesh->set_spatial_dimension(3);
51 
52  const libMesh::Sphere sphere(_center, _radius);
53 
54  // icosahedron points (using golden ratio rectangle construction)
55  const Real phi = (1.0 + std::sqrt(5.0)) / 2.0;
56  const Real X = std::sqrt(1.0 / (phi * phi + 1.0));
57  const Real Z = X * phi;
58  const Point vdata[12] = {{-X, 0.0, Z},
59  {X, 0.0, Z},
60  {-X, 0.0, -Z},
61  {X, 0.0, -Z},
62  {0.0, Z, X},
63  {0.0, Z, -X},
64  {0.0, -Z, X},
65  {0.0, -Z, -X},
66  {Z, X, 0.0},
67  {-Z, X, 0.0},
68  {Z, -X, 0.0},
69  {-Z, -X, 0.0}};
70  for (unsigned int i = 0; i < 12; ++i)
71  mesh->add_point(vdata[i] * _radius + _center, i);
72 
73  // icosahedron faces
74  const unsigned int tindices[20][3] = {{0, 4, 1}, {0, 9, 4}, {9, 5, 4}, {4, 5, 8}, {4, 8, 1},
75  {8, 10, 1}, {8, 3, 10}, {5, 3, 8}, {5, 2, 3}, {2, 7, 3},
76  {7, 10, 3}, {7, 6, 10}, {7, 11, 6}, {11, 0, 6}, {0, 1, 6},
77  {6, 1, 10}, {9, 0, 11}, {9, 11, 2}, {9, 2, 5}, {7, 2, 11}};
78  for (unsigned int i = 0; i < 20; ++i)
79  {
80  Elem * elem = mesh->add_elem(new Tri3);
81  elem->set_node(0, mesh->node_ptr(tindices[i][0]));
82  elem->set_node(1, mesh->node_ptr(tindices[i][1]));
83  elem->set_node(2, mesh->node_ptr(tindices[i][2]));
84  }
85 
86  // we need to prepare distributed meshes before using refinement
87  if (!mesh->is_replicated())
88  mesh->prepare_for_use();
89 
90  // Now we have the beginnings of a sphere.
91  // Add some more elements by doing uniform refinements and
92  // popping nodes to the boundary.
93  libMesh::MeshRefinement mesh_refinement(*mesh);
94 
95  // Loop over the elements, refine, pop nodes to boundary.
96  for (unsigned int r = 0; r < _depth; ++r)
97  {
98  mesh_refinement.uniformly_refine(1);
99 
100  auto it = mesh->active_nodes_begin();
101  const auto end = mesh->active_nodes_end();
102 
103  for (; it != end; ++it)
104  {
105  Node & node = **it;
106  node = sphere.closest_point(node);
107  }
108  }
109 
110  // Flatten the AMR mesh to get rid of inactive elements
111  MeshTools::Modification::flatten(*mesh);
112 
113  return dynamic_pointer_cast<MeshBase>(mesh);
114 }
mesh
MeshBase & mesh
dynamic_pointer_cast
std::unique_ptr< T_DEST, T_DELETER > dynamic_pointer_cast(std::unique_ptr< T_SRC, T_DELETER > &src)
SphereSurfaceMeshGenerator::_radius
const Real _radius
sphere radius
Definition: SphereSurfaceMeshGenerator.h:30
NS::Z
static const std::string Z
Definition: NS.h:169
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
MeshGenerator::buildMeshBaseObject
std::unique_ptr< MeshBase > buildMeshBaseObject(unsigned int dim=libMesh::invalid_uint)
SphereSurfaceMeshGenerator::_depth
const unsigned int _depth
recursion levels for triangle subdivision
Definition: SphereSurfaceMeshGenerator.h:36

◆ validParams()

InputParameters SphereSurfaceMeshGenerator::validParams ( )
static

Definition at line 24 of file SphereSurfaceMeshGenerator.C.

25 {
26  InputParameters params = MeshGenerator::validParams();
27  params.addClassDescription(
28  "Generated sphere mesh - a two dimensional manifold embedded in three dimensional space");
29  params.addParam<Real>("radius", 1.0, "Sphere radius");
30  params.addParam<Point>("center", Point(0, 0, 0), "Center of the sphere");
31  params.addParam<unsigned int>(
32  "depth", 3, "Iteration steps in the triangle bisection construction");
33  return params;
34 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
MeshGenerator::validParams
static InputParameters validParams()
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _center

const Point SphereSurfaceMeshGenerator::_center
protected

Definition at line 33 of file SphereSurfaceMeshGenerator.h.

Referenced by generate().

◆ _depth

const unsigned int SphereSurfaceMeshGenerator::_depth
protected

recursion levels for triangle subdivision

Definition at line 36 of file SphereSurfaceMeshGenerator.h.

Referenced by generate().

◆ _radius

const Real SphereSurfaceMeshGenerator::_radius
protected

sphere radius

Definition at line 30 of file SphereSurfaceMeshGenerator.h.

Referenced by generate().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:51:25 for https://mooseframework.inl.gov by   doxygen 1.8.14