Mesh generator for hexagonal duct. More...

#include <SCMTriDuctMeshGenerator.h>

Inheritance diagram for SCMTriDuctMeshGenerator:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	SCMTriDuctMeshGenerator (const InputParameters &parameters)

std::unique_ptr< MeshBase >	generate () override

std::unique_ptr< CSG::CSGBase >	generateInternalCSG ()

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	hasGenerateCSG () const

bool	isDataOnly () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject (IsKokkosObjectKey &&) const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () 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 &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (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

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) 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 bool	hasGenerateCSG (const InputParameters &params)

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node)

static void	setHasGenerateData (InputParameters &params)

static void	setHasGenerateCSG (InputParameters &params)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	data_only_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
size_t	ductPointIndex (unsigned int points_per_layer, unsigned int layer, unsigned int point) const
	Returns an index into the vector of point/node positions used/generated by ductPoints. More...

void	ductCorners (std::vector< Point > &corners, Real flat_to_flat, const Point &center) const
	calculate the x-y coordinates of the corner points for the duct cross section. More...

void	ductXsec (std::vector< Point > &xsec, const std::vector< Point > &corners, unsigned int nrings, Real pitch, Real flat_to_flat) const
	calcultes the points around the duct cross section boundary (perpendicular to z axis) using assembly parameters. More...

void	ductPoints (std::vector< Point > &points, const std::vector< Point > &xsec, const std::vector< Real > &z_layers) const
	Calculates all the point/node positions that will be used to form elements making the duct. More...

void	ductElems (std::vector< std::vector< size_t >> &elem_point_indices, unsigned int n_layers, unsigned int points_per_layer) const
	Calculates the groups of points/nodes that comprise each element in the duct mesh. More...

void	buildDuct (std::unique_ptr< MeshBase > &mesh, std::vector< Node *> &duct_nodes, const std::vector< Point > &points, const std::vector< std::vector< size_t >> &elem_point_indices, SubdomainID block) const
	buildDuct generates and adds mesh node and element objects to the given mesh corresponding to the given points (from ductPoints) and elem_point_indices that identify node point groups forming elements (from ductElems) More...

virtual void	generateData ()

virtual std::unique_ptr< CSG::CSGBase >	generateCSG ()

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)

std::unique_ptr< CSG::CSGBase > &	getCSGBase (const std::string &param_name)

std::unique_ptr< CSG::CSGBase > &	getCSGBaseByName (const MeshGeneratorName &mesh_generator_name)

std::vector< std::unique_ptr< CSG::CSGBase > *>	getCSGBases (const std::string &param_name)

std::vector< std::unique_ptr< CSG::CSGBase > *>	getCSGBasesByName (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)

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

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 unsigned int	_n_cells
	number of axial cells More...

std::vector< Real >	_z_grid
	axial location of nodes 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...

const unsigned int	_block_id
	block index More...

const Real	_pitch
	Distance between the neighbor fuel pins, pitch. More...

const unsigned int	_n_rings
	number of rings of fuel pins More...

const Real	_flat_to_flat
	the distance between flat surfaces of the duct facing each other More...

MooseMesh *const	_mesh

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const Parallel::Communicator &	_communicator

Detailed Description

Mesh generator for hexagonal duct.

Definition at line 17 of file SCMTriDuctMeshGenerator.h.

Constructor & Destructor Documentation

◆ SCMTriDuctMeshGenerator()

SCMTriDuctMeshGenerator::SCMTriDuctMeshGenerator ( const InputParameters & parameters )

Definition at line 41 of file SCMTriDuctMeshGenerator.C.

   : MeshGenerator(params),
     _input(getMesh("input")),
     _n_cells(getParam<unsigned int>("n_cells")),
     _unheated_length_entry(getParam<Real>("unheated_length_entry")),
     _heated_length(getParam<Real>("heated_length")),
     _unheated_length_exit(getParam<Real>("unheated_length_exit")),
     _block_id(getParam<unsigned int>("block_id")),
     _pitch(getParam<Real>("pitch")),
     _n_rings(getParam<unsigned int>("nrings")),
     _flat_to_flat(getParam<Real>("flat_to_flat"))
 {
   SubChannelMesh::generateZGrid(
       _unheated_length_entry, _heated_length, _unheated_length_exit, _n_cells, _z_grid);
 }

Member Function Documentation

◆ buildDuct()

void SCMTriDuctMeshGenerator::buildDuct	(	std::unique_ptr< MeshBase > &	mesh,
		std::vector< Node *> &	duct_nodes,
		const std::vector< Point > &	points,
		const std::vector< std::vector< size_t >> &	elem_point_indices,
		SubdomainID	block
	)		const

protected

buildDuct generates and adds mesh node and element objects to the given mesh corresponding to the given points (from ductPoints) and elem_point_indices that identify node point groups forming elements (from ductElems)

Definition at line 169 of file SCMTriDuctMeshGenerator.C.

Referenced by generate().

 {
   for (size_t i = 0; i < points.size(); i++)
     duct_nodes.push_back(mesh->add_point(points[i]));
 
   for (auto & elem_indices : elem_point_indices)
   {
     auto elem = mesh->add_elem(new Quad4());
     elem->subdomain_id() = block;
     for (size_t i = 0; i < elem_indices.size(); i++)
       elem->set_node(i, duct_nodes[elem_indices[i]]);
   }
 }

◆ ductCorners()

void SCMTriDuctMeshGenerator::ductCorners	(	std::vector< Point > &	corners,
		Real	flat_to_flat,
		const Point &	center
	)		const

protected

calculate the x-y coordinates of the corner points for the duct cross section.

Definition at line 88 of file SCMTriDuctMeshGenerator.C.

Referenced by generate().

 {
   corners.resize(TriSubChannelMesh::N_CORNERS);
   Real r_corner = flat_to_flat / 2. / std::cos(libMesh::pi / 6.);
   for (size_t i = 0; i < TriSubChannelMesh::N_CORNERS; i++)
   {
     Real theta = i * libMesh::pi / 3.;
     Point corner = {r_corner * std::cos(theta), r_corner * std::sin(theta)};
     corners[i] = center + corner;
   }
 }

◆ ductElems()

void SCMTriDuctMeshGenerator::ductElems	(	std::vector< std::vector< size_t >> &	elem_point_indices,
		unsigned int	n_layers,
		unsigned int	points_per_layer
	)		const

protected

Calculates the groups of points/nodes that comprise each element in the duct mesh.

The groups are identified by indices into the points vector returned by ductPoints. n_layers is the number of z-axis layers the duct has (i.e. the number of z x-secs lining up with nodes. And points_per_layer is the number of nodes/points in each of those x-secs.

Definition at line 147 of file SCMTriDuctMeshGenerator.C.

Referenced by generate().

 {
   elem_point_indices.clear();
   for (unsigned int i = 0; i < n_layers - 1; i++)
   {
     unsigned int bottom = i;
     unsigned int top = i + 1;
     for (unsigned int j = 0; j < points_per_layer; j++)
     {
       unsigned int left = j;
       unsigned int right = (j + 1) % points_per_layer;
       elem_point_indices.push_back({ductPointIndex(points_per_layer, bottom, left),
                                     ductPointIndex(points_per_layer, bottom, right),
                                     ductPointIndex(points_per_layer, top, right),
                                     ductPointIndex(points_per_layer, top, left)});
     }
   }
 }

◆ ductPointIndex()

size_t SCMTriDuctMeshGenerator::ductPointIndex	(	unsigned int	points_per_layer,
		unsigned int	layer,
		unsigned int	point
	)		const

protected

Returns an index into the vector of point/node positions used/generated by ductPoints.

This is used for mapping a xsec point index and a z-axis layer index to its corresponding point vector index.

Definition at line 128 of file SCMTriDuctMeshGenerator.C.

Referenced by ductElems(), and ductPoints().

 {
   return layer * points_per_layer + point;
 }

◆ ductPoints()

void SCMTriDuctMeshGenerator::ductPoints	(	std::vector< Point > &	points,
		const std::vector< Point > &	xsec,
		const std::vector< Real > &	z_layers
	)		const

protected

Calculates all the point/node positions that will be used to form elements making the duct.

Definition at line 136 of file SCMTriDuctMeshGenerator.C.

Referenced by generate().

 {
   points.resize(xsec.size() * z_layers.size());
   for (size_t i = 0; i < z_layers.size(); i++)
     for (size_t j = 0; j < xsec.size(); j++)
       points[ductPointIndex(xsec.size(), i, j)] = Point(xsec[j](0), xsec[j](1), z_layers[i]);
 }

◆ ductXsec()

void SCMTriDuctMeshGenerator::ductXsec	(	std::vector< Point > &	xsec,
		const std::vector< Point > &	corners,
		unsigned int	nrings,
		Real	pitch,
		Real	flat_to_flat
	)		const

protected

calcultes the points around the duct cross section boundary (perpendicular to z axis) using assembly parameters.

xsec will contain the points that

Definition at line 103 of file SCMTriDuctMeshGenerator.C.

Referenced by generate().

 {
   xsec.clear();
 
   Real r_corner = flat_to_flat / 2. / std::cos(libMesh::pi / 6.);
   Real start_offset = (r_corner - (nrings - 2) * pitch) * std::sin(libMesh::pi / 6.);
   Real side_length = (corners[0] - corners[1]).norm();
 
   for (size_t i = 0; i < corners.size(); i++)
   {
     auto left = corners[i];
     auto right = corners[(i + 1) % corners.size()];
     xsec.push_back(left);
     auto direc = (right - left).unit();
     for (Real offset_from_corner = start_offset; offset_from_corner < side_length;
          offset_from_corner += pitch)
       xsec.push_back(left + direc * offset_from_corner);
   }
 }

◆ generate()

std::unique_ptr< MeshBase > SCMTriDuctMeshGenerator::generate ( )

overridevirtual

Implements MeshGenerator.

Definition at line 58 of file SCMTriDuctMeshGenerator.C.

 {
   std::unique_ptr<MeshBase> mesh_base = std::move(_input);
   if (!mesh_base)
     mooseError("SCMTriDuctMeshGenerator has to be connected to a sub channel mesh generator.");
 
   mesh_base->set_mesh_dimension(3);
 
   std::vector<Point> corners;
   ductCorners(corners, _flat_to_flat, Point(0, 0, 0));
   std::vector<Point> xsec;
   ductXsec(xsec, corners, _n_rings, _pitch, _flat_to_flat);
   std::vector<Point> points;
   ductPoints(points, xsec, _z_grid);
   std::vector<std::vector<size_t>> elem_point_indices;
   ductElems(elem_point_indices, _z_grid.size(), xsec.size());
   std::vector<Node *> duct_nodes;
   buildDuct(mesh_base, duct_nodes, points, elem_point_indices, _block_id);
   mesh_base->subdomain_name(_block_id) = name();
 
   mesh_base->prepare_for_use();
 
   auto & sch_mesh = static_cast<TriSubChannelMesh &>(*_mesh);
   sch_mesh.setChannelToDuctMaps(duct_nodes);
   sch_mesh._duct_mesh_exist = true;
 
   return mesh_base;
 }

◆ validParams()

InputParameters SCMTriDuctMeshGenerator::validParams ( )

static

Definition at line 23 of file SCMTriDuctMeshGenerator.C.

 {
   InputParameters params = MeshGenerator::validParams();
   params.addClassDescription(
       "Creates a mesh of 1D duct cells around a triangular lattice subassembly");
   params.addRequiredParam<MeshGeneratorName>("input", "The corresponding subchannel mesh");
   params.addParam<unsigned int>("block_id", 2, "Domain Index");
   params.addRequiredParam<unsigned int>("n_cells", "The number of cells in the axial direction");
   params.addParam<Real>("unheated_length_entry", 0.0, "Unheated length at entry [m]");
   params.addRequiredParam<Real>("heated_length", "Heated length [m]");
   params.addParam<Real>("unheated_length_exit", 0.0, "Unheated length at exit [m]");
   params.addRequiredParam<Real>("pitch", "Pitch [m]");
   params.addRequiredParam<unsigned int>("nrings", "Number of fuel Pin rings per assembly [-]");
   params.addRequiredParam<Real>("flat_to_flat",
                                 "Flat to flat distance for the hexagonal assembly [m]");
   return params;
 }

Member Data Documentation

◆ _block_id

const unsigned int SCMTriDuctMeshGenerator::_block_id

protected

block index

Definition at line 91 of file SCMTriDuctMeshGenerator.h.

Referenced by generate().

◆ _flat_to_flat

const Real SCMTriDuctMeshGenerator::_flat_to_flat

protected

the distance between flat surfaces of the duct facing each other

Definition at line 97 of file SCMTriDuctMeshGenerator.h.

Referenced by generate().

◆ _heated_length

const Real SCMTriDuctMeshGenerator::_heated_length

protected

heated length of the fuel Pin

Definition at line 87 of file SCMTriDuctMeshGenerator.h.

Referenced by SCMTriDuctMeshGenerator().

◆ _input

std::unique_ptr<MeshBase>& SCMTriDuctMeshGenerator::_input

protected

Mesh that comes from another generator.

Definition at line 79 of file SCMTriDuctMeshGenerator.h.

Referenced by generate().

◆ _n_cells

const unsigned int SCMTriDuctMeshGenerator::_n_cells

protected

number of axial cells

Definition at line 81 of file SCMTriDuctMeshGenerator.h.

Referenced by SCMTriDuctMeshGenerator().

◆ _n_rings

const unsigned int SCMTriDuctMeshGenerator::_n_rings

protected

number of rings of fuel pins

Definition at line 95 of file SCMTriDuctMeshGenerator.h.

Referenced by generate().

◆ _pitch

const Real SCMTriDuctMeshGenerator::_pitch

protected

Distance between the neighbor fuel pins, pitch.

Definition at line 93 of file SCMTriDuctMeshGenerator.h.

Referenced by generate().

◆ _unheated_length_entry

const Real SCMTriDuctMeshGenerator::_unheated_length_entry

protected

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

Definition at line 85 of file SCMTriDuctMeshGenerator.h.

Referenced by SCMTriDuctMeshGenerator().

◆ _unheated_length_exit

const Real SCMTriDuctMeshGenerator::_unheated_length_exit

protected

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

Definition at line 89 of file SCMTriDuctMeshGenerator.h.

Referenced by SCMTriDuctMeshGenerator().

◆ _z_grid

std::vector<Real> SCMTriDuctMeshGenerator::_z_grid

protected

axial location of nodes

Definition at line 83 of file SCMTriDuctMeshGenerator.h.

Referenced by generate(), and SCMTriDuctMeshGenerator().

The documentation for this class was generated from the following files:

subchannel/include/meshgenerators/SCMTriDuctMeshGenerator.h
subchannel/src/meshgenerators/SCMTriDuctMeshGenerator.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCMTriDuctMeshGenerator()

Member Function Documentation

◆ buildDuct()

◆ ductCorners()

◆ ductElems()

◆ ductPointIndex()

◆ ductPoints()

◆ ductXsec()

◆ generate()

◆ validParams()

Member Data Documentation

◆ _block_id

◆ _flat_to_flat

◆ _heated_length

◆ _input

◆ _n_cells

◆ _n_rings

◆ _pitch

◆ _unheated_length_entry

◆ _unheated_length_exit

◆ _z_grid