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
SCMQuadPinMeshGenerator Class Reference

Class to create Pin mesh in the square lattice geometry. More...

#include <SCMQuadPinMeshGenerator.h>

Inheritance diagram for SCMQuadPinMeshGenerator:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 SCMQuadPinMeshGenerator (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

std::unique_ptr< MeshBase > & _input
 Mesh that comes from another generator. More...
 
const Real _unheated_length_entry
 unheated length of the fuel Pin at the entry of the assembly More...
 
const Real _heated_length
 heated length of the fuel Pin More...
 
const Real _unheated_length_exit
 unheated length of the fuel Pin at the exit of the assembly More...
 
std::vector< Real > _z_grid
 axial location of nodes More...
 
const Real _pitch
 Distance between the neighbor fuel pins, pitch. More...
 
const unsigned int _nx
 number of subchannels in the x direction More...
 
const unsigned int _ny
 number of subchannels in the y direction More...
 
const unsigned int _n_cells
 number of axial cells More...
 
std::vector< std::vector< Node * > > _pin_nodes
 Pin nodes. More...
 
const unsigned int _block_id
 block index 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

Class to create Pin mesh in the square lattice geometry.

Definition at line 19 of file SCMQuadPinMeshGenerator.h.

Constructor & Destructor Documentation

◆ SCMQuadPinMeshGenerator()

SCMQuadPinMeshGenerator::SCMQuadPinMeshGenerator ( const InputParameters &  parameters)

Definition at line 37 of file SCMQuadPinMeshGenerator.C.

38  : MeshGenerator(params),
39  _input(getMesh("input")),
40  _unheated_length_entry(getParam<Real>("unheated_length_entry")),
41  _heated_length(getParam<Real>("heated_length")),
42  _unheated_length_exit(getParam<Real>("unheated_length_exit")),
43  _pitch(getParam<Real>("pitch")),
44  _nx(getParam<unsigned int>("nx")),
45  _ny(getParam<unsigned int>("ny")),
46  _n_cells(getParam<unsigned int>("n_cells")),
47  _block_id(getParam<unsigned int>("block_id"))
48 {
49  Real dz = (_unheated_length_entry + _heated_length + _unheated_length_exit) / _n_cells;
50  for (unsigned int i = 0; i < _n_cells + 1; i++)
51  _z_grid.push_back(dz * i);
52 }
SCMQuadPinMeshGenerator::_n_cells
const unsigned int _n_cells
number of axial cells
Definition: SCMQuadPinMeshGenerator.h:43
SCMQuadPinMeshGenerator::_heated_length
const Real _heated_length
heated length of the fuel Pin
Definition: SCMQuadPinMeshGenerator.h:31
SCMQuadPinMeshGenerator::_unheated_length_exit
const Real _unheated_length_exit
unheated length of the fuel Pin at the exit of the assembly
Definition: SCMQuadPinMeshGenerator.h:33
SCMQuadPinMeshGenerator::_block_id
const unsigned int _block_id
block index
Definition: SCMQuadPinMeshGenerator.h:47
SCMQuadPinMeshGenerator::_input
std::unique_ptr< MeshBase > & _input
Mesh that comes from another generator.
Definition: SCMQuadPinMeshGenerator.h:27
MeshGenerator::MeshGenerator
MeshGenerator(const InputParameters &parameters)
MeshGenerator::getMesh
std::unique_ptr< MeshBase > & getMesh(const std::string &param_name, const bool allow_invalid=false)
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
SCMQuadPinMeshGenerator::_ny
const unsigned int _ny
number of subchannels in the y direction
Definition: SCMQuadPinMeshGenerator.h:41
SCMQuadPinMeshGenerator::_z_grid
std::vector< Real > _z_grid
axial location of nodes
Definition: SCMQuadPinMeshGenerator.h:35
SCMQuadPinMeshGenerator::_nx
const unsigned int _nx
number of subchannels in the x direction
Definition: SCMQuadPinMeshGenerator.h:39
SCMQuadPinMeshGenerator::_pitch
const Real _pitch
Distance between the neighbor fuel pins, pitch.
Definition: SCMQuadPinMeshGenerator.h:37
SCMQuadPinMeshGenerator::_unheated_length_entry
const Real _unheated_length_entry
unheated length of the fuel Pin at the entry of the assembly
Definition: SCMQuadPinMeshGenerator.h:29

Member Function Documentation

◆ generate()

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

Implements MeshGenerator.

Definition at line 55 of file SCMQuadPinMeshGenerator.C.

56 {
57  std::unique_ptr<MeshBase> mesh_base = std::move(_input);
58  if (!mesh_base)
59  mesh_base = buildMeshBaseObject();
60  mesh_base->set_mesh_dimension(3);
61  mesh_base->reserve_elem(_n_cells * (_ny - 1) * (_nx - 1));
62  mesh_base->reserve_nodes((_n_cells + 1) * (_ny - 1) * (_nx - 1));
63  _pin_nodes.resize((_nx - 1) * (_ny - 1));
64  // number of nodes in subchannel mesh
65  unsigned int node_sub = (_n_cells + 1) * _ny * _nx;
66  // number of elements in subchannel mesh
67  unsigned int elem_sub = _n_cells * _ny * _nx;
68 
69  // Add the points in the shape of a rectilinear grid. The grid is regular
70  // on the xy-plane with a spacing of `pitch` between points. The grid along
71  // z is also regular. Store pointers in the _nodes
72  // array so we can keep track of which points are in which pins.
73  Real offset_x = (_nx - 2) * _pitch / 2.0;
74  Real offset_y = (_ny - 2) * _pitch / 2.0;
75  unsigned int node_id = node_sub;
76  for (unsigned int iy = 0; iy < _ny - 1; iy++)
77  {
78  for (unsigned int ix = 0; ix < _nx - 1; ix++)
79  {
80  int i_node = (_nx - 1) * iy + ix;
81  _pin_nodes[i_node].reserve(_n_cells);
82  for (unsigned int iz = 0; iz < _n_cells + 1; iz++)
83  {
84  _pin_nodes[i_node].push_back(mesh_base->add_point(
85  Point(_pitch * ix - offset_x, _pitch * iy - offset_y, _z_grid[iz]), node_id++));
86  }
87  }
88  }
89 
90  // Add the elements which in this case are 2-node edges that link each
91  // subchannel's nodes vertically.
92  unsigned int elem_id = elem_sub;
93  for (unsigned int iy = 0; iy < _ny - 1; iy++)
94  {
95  for (unsigned int ix = 0; ix < _nx - 1; ix++)
96  {
97  for (unsigned int iz = 0; iz < _n_cells; iz++)
98  {
99  Elem * elem = new Edge2;
100  elem->subdomain_id() = _block_id;
101  elem->set_id(elem_id++);
102  elem = mesh_base->add_elem(elem);
103  const int indx1 = ((_n_cells + 1) * (_nx - 1)) * iy + (_n_cells + 1) * ix + iz + node_sub;
104  const int indx2 =
105  ((_n_cells + 1) * (_nx - 1)) * iy + (_n_cells + 1) * ix + (iz + 1) + node_sub;
106  elem->set_node(0, mesh_base->node_ptr(indx1));
107  elem->set_node(1, mesh_base->node_ptr(indx2));
108  }
109  }
110  }
111  mesh_base->subdomain_name(_block_id) = name();
112  mesh_base->prepare_for_use();
113 
114  // move the meta data into QuadSubChannelMesh
115  auto & sch_mesh = static_cast<QuadSubChannelMesh &>(*_mesh);
116  sch_mesh._pin_nodes = _pin_nodes;
117  sch_mesh._pin_mesh_exist = true;
118 
119  return mesh_base;
120 }
SCMQuadPinMeshGenerator::_n_cells
const unsigned int _n_cells
number of axial cells
Definition: SCMQuadPinMeshGenerator.h:43
SCMQuadPinMeshGenerator::_pin_nodes
std::vector< std::vector< Node * > > _pin_nodes
Pin nodes.
Definition: SCMQuadPinMeshGenerator.h:45
SCMQuadPinMeshGenerator::_block_id
const unsigned int _block_id
block index
Definition: SCMQuadPinMeshGenerator.h:47
SCMQuadPinMeshGenerator::_input
std::unique_ptr< MeshBase > & _input
Mesh that comes from another generator.
Definition: SCMQuadPinMeshGenerator.h:27
QuadSubChannelMesh
Creates the mesh of subchannels in a quadrilateral lattice.
Definition: QuadSubChannelMesh.h:18
MeshGenerator::name
virtual const std::string & name() const
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
SCMQuadPinMeshGenerator::_ny
const unsigned int _ny
number of subchannels in the y direction
Definition: SCMQuadPinMeshGenerator.h:41
QuadSubChannelMesh::_pin_nodes
std::vector< std::vector< Node * > > _pin_nodes
vector of fuel pin nodes
Definition: QuadSubChannelMesh.h:125
SCMQuadPinMeshGenerator::_z_grid
std::vector< Real > _z_grid
axial location of nodes
Definition: SCMQuadPinMeshGenerator.h:35
MeshGenerator::buildMeshBaseObject
std::unique_ptr< MeshBase > buildMeshBaseObject(unsigned int dim=libMesh::invalid_uint)
SCMQuadPinMeshGenerator::_nx
const unsigned int _nx
number of subchannels in the x direction
Definition: SCMQuadPinMeshGenerator.h:39
SCMQuadPinMeshGenerator::_pitch
const Real _pitch
Distance between the neighbor fuel pins, pitch.
Definition: SCMQuadPinMeshGenerator.h:37

◆ validParams()

InputParameters SCMQuadPinMeshGenerator::validParams ( )
static

Definition at line 21 of file SCMQuadPinMeshGenerator.C.

22 {
23  InputParameters params = MeshGenerator::validParams();
24  params.addClassDescription("Creates a mesh of 1D fuel pins in a square lattice arrangement");
25  params.addRequiredParam<MeshGeneratorName>("input", "The corresponding subchannel mesh");
26  params.addParam<Real>("unheated_length_entry", 0.0, "Unheated length at entry [m]");
27  params.addRequiredParam<Real>("heated_length", "Heated length [m]");
28  params.addParam<Real>("unheated_length_exit", 0.0, "Unheated length at exit [m]");
29  params.addRequiredParam<Real>("pitch", "Pitch [m]");
30  params.addRequiredParam<unsigned int>("nx", "Number of subchannels in the x direction [-]");
31  params.addRequiredParam<unsigned int>("ny", "Number of subchannels in the y direction [-]");
32  params.addRequiredParam<unsigned int>("n_cells", "The number of cells in the axial direction");
33  params.addParam<unsigned int>("block_id", 1, "Domain Index");
34  return params;
35 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, 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

◆ _block_id

const unsigned int SCMQuadPinMeshGenerator::_block_id
protected

block index

Definition at line 47 of file SCMQuadPinMeshGenerator.h.

Referenced by generate().

◆ _heated_length

const Real SCMQuadPinMeshGenerator::_heated_length
protected

heated length of the fuel Pin

Definition at line 31 of file SCMQuadPinMeshGenerator.h.

Referenced by SCMQuadPinMeshGenerator().

◆ _input

std::unique_ptr<MeshBase>& SCMQuadPinMeshGenerator::_input
protected

Mesh that comes from another generator.

Definition at line 27 of file SCMQuadPinMeshGenerator.h.

Referenced by generate().

◆ _n_cells

const unsigned int SCMQuadPinMeshGenerator::_n_cells
protected

number of axial cells

Definition at line 43 of file SCMQuadPinMeshGenerator.h.

Referenced by generate(), and SCMQuadPinMeshGenerator().

◆ _nx

const unsigned int SCMQuadPinMeshGenerator::_nx
protected

number of subchannels in the x direction

Definition at line 39 of file SCMQuadPinMeshGenerator.h.

Referenced by generate().

◆ _ny

const unsigned int SCMQuadPinMeshGenerator::_ny
protected

number of subchannels in the y direction

Definition at line 41 of file SCMQuadPinMeshGenerator.h.

Referenced by generate().

◆ _pin_nodes

std::vector<std::vector<Node *> > SCMQuadPinMeshGenerator::_pin_nodes
protected

Pin nodes.

Definition at line 45 of file SCMQuadPinMeshGenerator.h.

Referenced by generate().

◆ _pitch

const Real SCMQuadPinMeshGenerator::_pitch
protected

Distance between the neighbor fuel pins, pitch.

Definition at line 37 of file SCMQuadPinMeshGenerator.h.

Referenced by generate().

◆ _unheated_length_entry

const Real SCMQuadPinMeshGenerator::_unheated_length_entry
protected

unheated length of the fuel Pin at the entry of the assembly

Definition at line 29 of file SCMQuadPinMeshGenerator.h.

Referenced by SCMQuadPinMeshGenerator().

◆ _unheated_length_exit

const Real SCMQuadPinMeshGenerator::_unheated_length_exit
protected

unheated length of the fuel Pin at the exit of the assembly

Definition at line 33 of file SCMQuadPinMeshGenerator.h.

Referenced by SCMQuadPinMeshGenerator().

◆ _z_grid

std::vector<Real> SCMQuadPinMeshGenerator::_z_grid
protected

axial location of nodes

Definition at line 35 of file SCMQuadPinMeshGenerator.h.

Referenced by generate(), and SCMQuadPinMeshGenerator().

The documentation for this class was generated from the following files:
Generated on Thu Jul 17 2025 01:51:19 for https://mooseframework.inl.gov by   doxygen 1.8.14