This PeripheralRingMeshGenerator object adds a circular peripheral region to the input mesh. More...

#include <PeripheralRingMeshGenerator.h>

Inheritance diagram for PeripheralRingMeshGenerator:

Public Types
enum class	PolygonSizeStyle { apothem , radius }
	An enum class for style of input polygon size. More...

enum	MESH_TYPE { CORNER_MESH = 1 , BOUNDARY_MESH = 2 , INNER_MESH = 3 }

enum	RETURN_TYPE { ANGLE_DEGREE = 1 , ANGLE_TANGENT = 2 }

enum	INTRISIC_SUBDOMAIN_ID : subdomain_id_type { PERIPHERAL_ID_SHIFT = 1000 , TRANSITION_LAYER_DEFAULT = 10000 }

enum	INTRINSIC_SIDESET_ID : boundary_id_type { OUTER_SIDESET_ID = 10000 , OUTER_SIDESET_ID_ALT = 15000 , SLICE_BEGIN = 30000 , SLICE_END = 31000 , SLICE_ALT = 30500 }

enum	INTRINSIC_NUM_SIDES { HEXAGON_NUM_SIDES = 6 , SQUARE_NUM_SIDES = 4 }

enum class	TRI_ELEM_TYPE { TRI3 , TRI6 , TRI7 }

enum class	QUAD_ELEM_TYPE { QUAD4 , QUAD8 , QUAD9 }

typedef DataFileName	DataFileParameterType

Public Member Functions
	PeripheralRingMeshGenerator (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 () 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	mooseDeprecatedNoTrace (Args &&... args) const

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

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

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
void	innerBdryLayerNodesDefiner (const unsigned int input_ext_node_num, const std::vector< Real > input_bdry_angles, const std::vector< Point > ref_inner_bdry_surf, const std::vector< Real > inner_peripheral_bias_terms, const std::vector< Real > azi_array, const Point origin_pt, std::vector< std::vector< Point > > &points_array) const
	Define node positions of the inner boundary layer that is conformal to the input mesh's external boundary.

std::unique_ptr< ReplicatedMesh >	buildSimpleSlice (std::vector< Real > ring_radii, const std::vector< unsigned int > ring_layers, const std::vector< Real > ring_radial_biases, const multiBdryLayerParams &ring_inner_boundary_layer_params, const multiBdryLayerParams &ring_outer_boundary_layer_params, std::vector< Real > ducts_center_dist, const std::vector< unsigned int > ducts_layers, const std::vector< Real > duct_radial_biases, const multiBdryLayerParams &duct_inner_boundary_layer_params, const multiBdryLayerParams &duct_outer_boundary_layer_params, const Real pitch, const unsigned int num_sectors_per_side, const unsigned int background_intervals, const Real background_radial_bias, const singleBdryLayerParams &background_inner_boundary_layer_params, const singleBdryLayerParams &background_outer_boundary_layer_params, dof_id_type &node_id_background_meta, const unsigned int side_number, const unsigned int side_index, const std::vector< Real > azimuthal_tangent=std::vector< Real >(), const subdomain_id_type block_id_shift=0, const bool quad_center_elements=false, const Real center_quad_factor=0.0, const bool create_inward_interface_boundaries=false, const bool create_outward_interface_boundaries=true, const boundary_id_type boundary_id_shift=0, const bool generate_side_specific_boundaries=true, const TRI_ELEM_TYPE tri_elem_type=TRI_ELEM_TYPE::TRI3, const QUAD_ELEM_TYPE quad_elem_type=QUAD_ELEM_TYPE::QUAD4)
	Creates a mesh of a slice that corresponds to a single side of the polygon to be generated.

std::unique_ptr< ReplicatedMesh >	buildGeneralSlice (std::vector< Real > ring_radii, const std::vector< unsigned int > ring_layers, const std::vector< Real > ring_radial_biases, const multiBdryLayerParams &ring_inner_boundary_layer_params, const multiBdryLayerParams &ring_outer_boundary_layer_params, std::vector< Real > ducts_center_dist, const std::vector< unsigned int > ducts_layers, const std::vector< Real > duct_radial_biases, const multiBdryLayerParams &duct_inner_boundary_layer_params, const multiBdryLayerParams &duct_outer_boundary_layer_params, const Real primary_side_length, const Real secondary_side_length, const unsigned int num_sectors_per_side, const unsigned int background_intervals, const Real background_radial_bias, const singleBdryLayerParams &background_inner_boundary_layer_params, const singleBdryLayerParams &background_outer_boundary_layer_params, dof_id_type &node_id_background_meta, const Real azimuthal_angle, const std::vector< Real > azimuthal_tangent, const unsigned int side_index, const bool quad_center_elements, const Real center_quad_factor, const Real rotation_angle, const bool generate_side_specific_boundaries=true)
	Creates a mesh of a general polygon slice with a triangular shape and circular regions on one of its vertex.

std::unique_ptr< ReplicatedMesh >	buildSlice (std::vector< Real > ring_radii, const std::vector< unsigned int > ring_layers, const std::vector< Real > ring_radial_biases, const multiBdryLayerParams &ring_inner_boundary_layer_params, const multiBdryLayerParams &ring_outer_boundary_layer_params, std::vector< Real > ducts_center_dist, const std::vector< unsigned int > ducts_layers, const std::vector< Real > duct_radial_biases, const multiBdryLayerParams &duct_inner_boundary_layer_params, const multiBdryLayerParams &duct_outer_boundary_layer_params, const Real pitch, const unsigned int num_sectors_per_side, const unsigned int background_intervals, const Real background_radial_bias, const singleBdryLayerParams &background_inner_boundary_layer_params, const singleBdryLayerParams &background_outer_boundary_layer_params, dof_id_type &node_id_background_meta, const Real virtual_side_number, const unsigned int side_index, const std::vector< Real > azimuthal_tangent=std::vector< Real >(), const subdomain_id_type block_id_shift=0, const bool quad_center_elements=false, const Real center_quad_factor=0.0, const bool create_inward_interface_boundaries=false, const bool create_outward_interface_boundaries=true, const boundary_id_type boundary_id_shift=0, const Real pitch_scale_factor=1.0, const bool generate_side_specific_boundaries=true, const TRI_ELEM_TYPE tri_elem_type=TRI_ELEM_TYPE::TRI3, const QUAD_ELEM_TYPE quad_elem_type=QUAD_ELEM_TYPE::QUAD4)
	Generates a mesh of a polygon slice, which is the foundation of both buildGeneralSlice and buildSimpleSlice.

void	centerNodes (ReplicatedMesh &mesh, const Real virtual_side_number, const unsigned int div_num, const Real ring_radii_0, std::vector< std::vector< Node * > > &nodes) const
	Creates nodes of the very central mesh layer of the polygon for quad central elements.

void	ringNodes (ReplicatedMesh &mesh, const std::vector< Real > ring_radii, const std::vector< unsigned int > ring_layers, const std::vector< std::vector< Real > > biased_terms, const unsigned int num_sectors_per_side, const Real corner_p[2][2], const Real corner_to_corner, const std::vector< Real > azimuthal_tangent=std::vector< Real >()) const
	Creates nodes for the ring-geometry region of a single slice.

void	backgroundNodes (ReplicatedMesh &mesh, const unsigned int num_sectors_per_side, const unsigned int background_intervals, const std::vector< Real > biased_terms, const Real background_corner_distance, const Real background_corner_radial_interval_length, const Real corner_p[2][2], const Real corner_to_corner, const Real background_in, const std::vector< Real > azimuthal_tangent=std::vector< Real >()) const
	Creates nodes for the ring-to-polygon transition region (i.e., background) of a single slice.

void	ductNodes (ReplicatedMesh &mesh, std::vector< Real > *const ducts_center_dist, const std::vector< unsigned int > ducts_layers, const std::vector< std::vector< Real > > biased_terms, const unsigned int num_sectors_per_side, const Real corner_p[2][2], const Real corner_to_corner, const std::vector< Real > azimuthal_tangent=std::vector< Real >()) const
	Creates nodes for the duct-geometry region of a single slice.

void	cenQuadElemDef (ReplicatedMesh &mesh, const unsigned int div_num, const subdomain_id_type block_id_shift, const bool create_outward_interface_boundaries, const boundary_id_type boundary_id_shift, std::vector< std::vector< Node * > > &nodes, const bool assign_external_boundary=false, const unsigned int side_index=0, const bool generate_side_specific_boundaries=true, const QUAD_ELEM_TYPE quad_elem_type=QUAD_ELEM_TYPE::QUAD4) const
	Defines quad elements in the very central region of the polygon.

void	cenTriElemDef (ReplicatedMesh &mesh, const unsigned int num_sectors_per_side, const std::vector< Real > azimuthal_tangent=std::vector< Real >(), const subdomain_id_type block_id_shift=0, const bool create_outward_interface_boundaries=true, const boundary_id_type boundary_id_shift=0, const bool assign_external_boundary=false, const unsigned int side_index=0, const bool generate_side_specific_boundaries=true, const TRI_ELEM_TYPE tri_elem_type=TRI_ELEM_TYPE::TRI3) const
	Defines triangular elements in the very central region of the polygon.

void	quadElemDef (ReplicatedMesh &mesh, const unsigned int num_sectors_per_side, const std::vector< unsigned int > subdomain_rings, const unsigned int side_index, const std::vector< Real > azimuthal_tangent=std::vector< Real >(), const subdomain_id_type block_id_shift=0, const dof_id_type nodeid_shift=0, const bool create_inward_interface_boundaries=false, const bool create_outward_interface_boundaries=true, const boundary_id_type boundary_id_shift=0, const bool generate_side_specific_boundaries=true, const QUAD_ELEM_TYPE quad_elem_type=QUAD_ELEM_TYPE::QUAD4) const
	Defines general quad elements for the polygon.

std::unique_ptr< ReplicatedMesh >	buildSimplePeripheral (const unsigned int num_sectors_per_side, const unsigned int peripheral_invervals, const std::vector< std::pair< Real, Real > > &position_inner, const std::vector< std::pair< Real, Real > > &d_position_outer, const subdomain_id_type id_shift, const QUAD_ELEM_TYPE quad_elem_type, const bool create_inward_interface_boundaries=false, const bool create_outward_interface_boundaries=true)
	Creates peripheral area mesh for the patterned hexagon mesh.

void	adjustPeripheralQuadraticElements (MeshBase &out_mesh, const QUAD_ELEM_TYPE boundary_quad_elem_type) const
	Adjusts the mid-edge node locations in boundary regions when using quadratic elements with uniform boundary node spacing enabled.

std::pair< Real, Real >	pointInterpolate (const Real pi_1_x, const Real pi_1_y, const Real po_1_x, const Real po_1_y, const Real pi_2_x, const Real pi_2_y, const Real po_2_x, const Real po_2_y, const unsigned int i, const unsigned int j, const unsigned int num_sectors_per_side, const unsigned int peripheral_intervals) const
	Calculates the point coordinates of within a parallelogram region using linear interpolation.

void	nodeCoordRotate (Real &x, Real &y, const Real theta) const
	Calculates x and y coordinates after rotating by theta angle.

void	cutOffPolyDeform (MeshBase &mesh, const Real orientation, const Real y_max_0, const Real y_max_n, const Real y_min, const unsigned int mesh_type, const Real unit_angle=60.0, const Real tols=1E-5) const
	Deforms peripheral region when the external side of a polygon assembly of stitched meshes cuts off the stitched meshes.

std::pair< Real, Real >	fourPointIntercept (const std::pair< Real, Real > &p1, const std::pair< Real, Real > &p2, const std::pair< Real, Real > &p3, const std::pair< Real, Real > &p4) const
	Finds the center of a quadrilateral based on four vertices.

std::vector< Real >	azimuthalAnglesCollector (ReplicatedMesh &mesh, std::vector< Point > &boundary_points, const Real lower_azi=-30.0, const Real upper_azi=30.0, const unsigned int return_type=ANGLE_TANGENT, const unsigned int num_sides=6, const boundary_id_type bid=OUTER_SIDESET_ID, const bool calculate_origin=true, const Real input_origin_x=0.0, const Real input_origin_y=0.0, const Real tol=1.0E-10) const
	Collects sorted azimuthal angles of the external boundary.

std::vector< Real >	azimuthalAnglesCollector (ReplicatedMesh &mesh, const Real lower_azi=-30.0, const Real upper_azi=30.0, const unsigned int return_type=ANGLE_TANGENT, const unsigned int num_sides=6, const boundary_id_type bid=OUTER_SIDESET_ID, const bool calculate_origin=true, const Real input_origin_x=0.0, const Real input_origin_y=0.0, const Real tol=1.0E-10) const
	Collects sorted azimuthal angles of the external boundary.

std::vector< std::vector< Real > >	biasTermsCalculator (const std::vector< Real > radial_biases, const std::vector< unsigned int > intervals, const multiBdryLayerParams inner_boundary_layer_params, const multiBdryLayerParams outer_boundary_layer_params) const
	Creates bias terms for multiple blocks.

std::vector< Real >	biasTermsCalculator (const Real radial_bias, const unsigned int intervals, const singleBdryLayerParams inner_boundary_layer_params={0.0, 0.0, 0, 1.0}, const singleBdryLayerParams outer_boundary_layer_params={0.0, 0.0, 0, 1.0}) const
	Creates bias terms for a single block.

void	setSectorExtraIDs (MeshBase &mesh, const std::string id_name, const unsigned int num_sides, const std::vector< unsigned int > num_sectors_per_side)
	assign sector extra ids to polygon mesh

void	setRingExtraIDs (MeshBase &mesh, const std::string id_name, const unsigned int num_sides, const std::vector< unsigned int > num_sectors_per_side, const std::vector< unsigned int > ring_intervals, const bool ring_wise_id, const bool quad_center_elements)
	assign ring extra ids to polygon mesh

void	reassignBoundaryIDs (MeshBase &mesh, const boundary_id_type id_shift, const std::set< boundary_id_type > &boundary_ids, const bool reverse=false)
	reassign interface boundary IDs on the input mesh by applying the boundary ID shift

std::set< boundary_id_type >	getInterfaceBoundaryIDs (const std::vector< std::vector< unsigned int > > &pattern, const std::vector< std::vector< boundary_id_type > > &interface_boundary_id_shift_pattern, const std::set< boundary_id_type > &boundary_ids, const std::vector< std::set< boundary_id_type > > &input_interface_boundary_ids, const bool use_interface_boundary_id_shift, const bool create_interface_boundary_id, const unsigned int num_extra_layers) const
	returns a list of interface boundary IDs on the mesh generated by this mesh generator

multiBdryLayerParams	modifiedMultiBdryLayerParamsCreator (const multiBdryLayerParams &original_multi_bdry_layer_params, const unsigned int order) const
	Modifies the input multi boundary layer parameters for node generation, especially for the quadratic elements.

singleBdryLayerParams	modifiedSingleBdryLayerParamsCreator (const singleBdryLayerParams &original_single_bdry_layer_params, const unsigned int order) const
	Modifies the input single boundary layer parameters for node generation, especially for the quadratic elements.

std::string	pitchMetaDataErrorGenerator (const std::vector< MeshGeneratorName > &input_names, const std::vector< Real > &metadata_vals, const std::string &metadata_name) const
	Generate a string that contains the detailed metadata information for inconsistent input mesh metadata error messages.

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 void	addRingAndSectorIDParams (InputParameters &params)
	Add InputParameters which are used by ring and sector IDs.

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

Protected Attributes
const MeshGeneratorName	_input_name
	Name of the mesh generator to get the input mesh.

const bool	_force_input_centroid_as_center
	Whether to enforce use of the centroid position of the input mesh as the center of the peripheral ring.

const unsigned int	_peripheral_layer_num
	Number of layers of elements of the peripheral region in radial direction.

Real	_peripheral_radial_bias
	Bias value used to induce biasing to radial meshing in peripheral ring region.

singleBdryLayerParams	_peripheral_inner_boundary_layer_params
	Width, fraction, radiation sectors and growth factor of the inner boundary layer of the peripheral region.

singleBdryLayerParams	_peripheral_outer_boundary_layer_params
	Width, fraction, radiation sectors and growth factor of the outer boundary layer of the peripheral region.

const Real	_peripheral_ring_radius
	Radius of the peripheral region's outer circular boundary.

const bool	_preserve_volumes
	Volume preserving function is optional.

const BoundaryName	_input_mesh_external_boundary
	Name of the external boundary of the input mesh.

const subdomain_id_type	_peripheral_ring_block_id
	Subdomain ID of the added peripheral region.

const SubdomainName	_peripheral_ring_block_name
	Subdomain name of the added peripheral region.

const boundary_id_type	_external_boundary_id
	ID of the new external boundary.

const BoundaryName	_external_boundary_name
	Name of the new external boundary.

std::unique_ptr< MeshBase > &	_input
	Reference to input mesh pointer.

boundary_id_type	_input_mesh_external_bid
	ID of the external boundary of the input mesh.

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

Private Member Functions
virtual std::string	meshPropertyPrefix (const std::string &) const override final

void	checkGetMesh (const MeshGeneratorName &mesh_generator_name, const std::string &param_name) const

const MeshGeneratorName *	getMeshGeneratorNameFromParam (const std::string &param_name, const bool allow_invalid) const

const std::vector< MeshGeneratorName > &	getMeshGeneratorNamesFromParam (const std::string &param_name) const

RestartableDataValue &	setMeshPropertyHelper (const std::string &data_name)

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

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

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
std::set< MeshGeneratorName >	_requested_mesh_generators

std::set< MeshGeneratorName >	_requested_mesh_generators_for_sub

std::vector< std::pair< std::string, std::unique_ptr< MeshBase > * > >	_requested_meshes

std::vector< std::pair< std::string, std::unique_ptr< CSG::CSGBase > * > >	_requested_csg_bases

std::unique_ptr< MeshBase >	_null_mesh

std::unique_ptr< CSG::CSGBase >	_null_csg_base

std::set< const MeshGenerator *, Comparator >	_parent_mesh_generators

std::set< const MeshGenerator *, Comparator >	_child_mesh_generators

std::set< const MeshGenerator *, Comparator >	_sub_mesh_generators

std::set< std::string >	_null_mesh_names

const std::string &	_save_with_name

const bool	_data_only

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

Detailed Description

This PeripheralRingMeshGenerator object adds a circular peripheral region to the input mesh.

Definition at line 20 of file PeripheralRingMeshGenerator.h.

Member Enumeration Documentation

◆ INTRINSIC_NUM_SIDES

enum PolygonMeshGeneratorBase::INTRINSIC_NUM_SIDES

inherited

Enumerator
HEXAGON_NUM_SIDES
SQUARE_NUM_SIDES

Definition at line 75 of file PolygonMeshGeneratorBase.h.

  {
    HEXAGON_NUM_SIDES = 6,
    SQUARE_NUM_SIDES = 4
  };

◆ INTRINSIC_SIDESET_ID

enum PolygonMeshGeneratorBase::INTRINSIC_SIDESET_ID : boundary_id_type

inherited

Enumerator
OUTER_SIDESET_ID
OUTER_SIDESET_ID_ALT
SLICE_BEGIN
SLICE_END
SLICE_ALT

Definition at line 66 of file PolygonMeshGeneratorBase.h.

  {
    OUTER_SIDESET_ID = 10000,
    OUTER_SIDESET_ID_ALT = 15000,
    SLICE_BEGIN = 30000,
    SLICE_END = 31000,
    SLICE_ALT = 30500
  };

◆ INTRISIC_SUBDOMAIN_ID

enum PolygonMeshGeneratorBase::INTRISIC_SUBDOMAIN_ID : subdomain_id_type

inherited

Enumerator
PERIPHERAL_ID_SHIFT
TRANSITION_LAYER_DEFAULT

Definition at line 60 of file PolygonMeshGeneratorBase.h.

  {
    PERIPHERAL_ID_SHIFT = 1000,
    TRANSITION_LAYER_DEFAULT = 10000
  };

◆ MESH_TYPE

enum PolygonMeshGeneratorBase::MESH_TYPE

inherited

Enumerator
CORNER_MESH
BOUNDARY_MESH
INNER_MESH

Definition at line 47 of file PolygonMeshGeneratorBase.h.

  {
    CORNER_MESH = 1,
    BOUNDARY_MESH = 2,
    INNER_MESH = 3
  };

◆ PolygonSizeStyle

enum class PolygonMeshGeneratorBase::PolygonSizeStyle

stronginherited

An enum class for style of input polygon size.

Enumerator
apothem
radius

Definition at line 41 of file PolygonMeshGeneratorBase.h.

  {
    apothem,
    radius
  };

◆ QUAD_ELEM_TYPE

enum class PolygonMeshGeneratorBase::QUAD_ELEM_TYPE

stronginherited

Enumerator
QUAD4
QUAD8
QUAD9

Definition at line 88 of file PolygonMeshGeneratorBase.h.

  {
    QUAD4,
    QUAD8,
    QUAD9
  };

◆ RETURN_TYPE

enum PolygonMeshGeneratorBase::RETURN_TYPE

inherited

Enumerator
ANGLE_DEGREE
ANGLE_TANGENT

Definition at line 54 of file PolygonMeshGeneratorBase.h.

  {
    ANGLE_DEGREE = 1,
    ANGLE_TANGENT = 2
  };

◆ TRI_ELEM_TYPE

enum class PolygonMeshGeneratorBase::TRI_ELEM_TYPE

stronginherited

Enumerator
TRI3
TRI6
TRI7

Definition at line 81 of file PolygonMeshGeneratorBase.h.

  {
    TRI3,
    TRI6,
    TRI7
  };

Constructor & Destructor Documentation

◆ PeripheralRingMeshGenerator()

PeripheralRingMeshGenerator::PeripheralRingMeshGenerator ( const InputParameters & parameters )

Definition at line 105 of file PeripheralRingMeshGenerator.C.

  : PolygonMeshGeneratorBase(parameters),
    _input_name(getParam<MeshGeneratorName>("input")),
    _force_input_centroid_as_center(getParam<bool>("force_input_centroid_as_center")),
    _peripheral_layer_num(getParam<unsigned int>("peripheral_layer_num")),
    _peripheral_radial_bias(getParam<Real>("peripheral_radial_bias")),
    _peripheral_inner_boundary_layer_params(
        {getParam<Real>("peripheral_inner_boundary_layer_width"),
         0.0,
         getParam<Real>("peripheral_inner_boundary_layer_width") > 0.0
             ? getParam<unsigned int>("peripheral_inner_boundary_layer_intervals")
             : 0,
         getParam<Real>("peripheral_inner_boundary_layer_bias")}),
    _peripheral_outer_boundary_layer_params(
        {getParam<Real>("peripheral_outer_boundary_layer_width"),
         0.0,
         getParam<Real>("peripheral_outer_boundary_layer_width") > 0.0
             ? getParam<unsigned int>("peripheral_outer_boundary_layer_intervals")
             : 0,
         getParam<Real>("peripheral_outer_boundary_layer_bias")}),
    _peripheral_ring_radius(getParam<Real>("peripheral_ring_radius")),
    _preserve_volumes(getParam<bool>("preserve_volumes")),
    _input_mesh_external_boundary(getParam<BoundaryName>("input_mesh_external_boundary")),
    _peripheral_ring_block_id(getParam<subdomain_id_type>("peripheral_ring_block_id")),
    _peripheral_ring_block_name(isParamValid("peripheral_ring_block_name")
                                    ? getParam<SubdomainName>("peripheral_ring_block_name")
                                    : (SubdomainName) ""),
    _external_boundary_id(isParamValid("external_boundary_id")
                              ? getParam<boundary_id_type>("external_boundary_id")
                              : 0),
    _external_boundary_name(getParam<BoundaryName>("external_boundary_name")),
    _input(getMeshByName(_input_name))
{
  declareMeshProperty<bool>("hexagon_peripheral_trimmability", false);
  declareMeshProperty<bool>("hexagon_center_trimmability", false);
  declareMeshProperty<bool>("square_peripheral_trimmability", false);
  declareMeshProperty<bool>("square_center_trimmability", false);
}

Member Function Documentation

◆ addRingAndSectorIDParams()

void PolygonMeshGeneratorBase::addRingAndSectorIDParams ( InputParameters & params )

staticprotectedinherited

Add InputParameters which are used by ring and sector IDs.

Parameters

params InputParameters to be modified with the added params

Definition at line 1596 of file PolygonMeshGeneratorBase.C.

{
  params.addParam<std::string>("sector_id_name",
                               "Name of integer (reporting) ID for sector regions to use the "
                               "reporting ID for azimuthal sector regions of ring geometry block.");
  params.addParam<std::string>("ring_id_name",
                               "Name of integer (reporting) ID for ring regions to use the "
                               "reporting ID for annular regions of ring geometry block.");
  MooseEnum ring_id_option("block_wise ring_wise", "block_wise");
  params.addParam<MooseEnum>(
      "ring_id_assign_type", ring_id_option, "Type of ring ID assignment: block_wise or ring_wise");
  params.addParamNamesToGroup("sector_id_name ring_id_name ring_id_assign_type", "Ring/Sector IDs");
}

Referenced by PolygonConcentricCircleMeshGeneratorBase::validParams(), and TriPinHexAssemblyGenerator::validParams().

◆ adjustPeripheralQuadraticElements()

void PolygonMeshGeneratorBase::adjustPeripheralQuadraticElements	(	MeshBase &	out_mesh,
		const QUAD_ELEM_TYPE	boundary_quad_elem_type
	)		const

protectedinherited

Adjusts the mid-edge node locations in boundary regions when using quadratic elements with uniform boundary node spacing enabled.

Parameters

out_mesh	mesh to be adjusted.
boundary_quad_elem_type	boundary quad element type.

Definition at line 1251 of file PolygonMeshGeneratorBase.C.

{
  const auto side_list = out_mesh.get_boundary_info().build_side_list();
 
  // select out elements on outer boundary
  // std::set used to filter duplicate elem_ids
  std::set<dof_id_type> elem_set;
  for (auto side_item : side_list)
  {
    boundary_id_type boundary_id = std::get<2>(side_item);
    dof_id_type elem_id = std::get<0>(side_item);
 
    if (boundary_id == OUTER_SIDESET_ID)
      elem_set.insert(elem_id);
  }
 
  // adjust nodes for outer boundary elements
  for (const auto elem_id : elem_set)
  {
    Elem * elem = out_mesh.elem_ptr(elem_id);
 
    // adjust right side mid-edge node
    Point pt_5 = (elem->point(1) + elem->point(2)) / 2.0;
    out_mesh.add_point(pt_5, elem->node_ptr(5)->id());
 
    // adjust left side mid-edge node
    Point pt_7 = (elem->point(0) + elem->point(3)) / 2.0;
    out_mesh.add_point(pt_7, elem->node_ptr(7)->id());
 
    // adjust central node when using QUAD9
    if (boundary_quad_elem_type == QUAD_ELEM_TYPE::QUAD9)
    {
      Point pt_8 = elem->true_centroid();
      out_mesh.add_point(pt_8, elem->node_ptr(8)->id());
    }
  }
}

Referenced by PatternedCartesianMeshGenerator::generate(), and PatternedHexMeshGenerator::generate().

◆ azimuthalAnglesCollector() [1/2]

std::vector< Real > PolygonMeshGeneratorBase::azimuthalAnglesCollector	(	ReplicatedMesh &	mesh,
		const Real	lower_azi = `-30.0`,
		const Real	upper_azi = `30.0`,
		const unsigned int	return_type = `ANGLE_TANGENT`,
		const unsigned int	num_sides = `6`,
		const boundary_id_type	bid = `OUTER_SIDESET_ID`,
		const bool	calculate_origin = `true`,
		const Real	input_origin_x = `0.0`,
		const Real	input_origin_y = `0.0`,
		const Real	tol = `1.0E-10`
	)		const

protectedinherited

Collects sorted azimuthal angles of the external boundary.

Parameters

mesh	input mesh whose boundary node azimuthal angles need to be collected
lower_azi	lower boundary of the azimuthal angles to be collected
upper_azi	upper boundary of the azimuthal angles to be collected
return_type	whether angle values or tangent values are returned
num_sides	number of sides of the input mesh (only used if return type is ANGLE_TANGENT)
bid	id of the boundary of which the nodes' azimuthal angles are collected
calculate_origin	whether the mesh origin is calculated based on the centroid position
input_origin_x	precalculated mesh origin coordinate x
input_origin_y	precalculated mesh origin coordinate y
tol	tolerence that the minimum azimuthal angle is

Returns: the list of azimuthal angles of all the nodes on the external grain boundary within the given range

Definition at line 1495 of file PolygonMeshGeneratorBase.C.

{
  std::vector<Point> boundary_points;
  return azimuthalAnglesCollector(mesh,
                                  boundary_points,
                                  lower_azi,
                                  upper_azi,
                                  return_type,
                                  num_sides,
                                  bid,
                                  calculate_origin,
                                  input_origin_x,
                                  input_origin_y,
                                  tol);
}

◆ azimuthalAnglesCollector() [2/2]

std::vector< Real > PolygonMeshGeneratorBase::azimuthalAnglesCollector	(	ReplicatedMesh &	mesh,
		std::vector< Point > &	boundary_points,
		const Real	lower_azi = `-30.0`,
		const Real	upper_azi = `30.0`,
		const unsigned int	return_type = `ANGLE_TANGENT`,
		const unsigned int	num_sides = `6`,
		const boundary_id_type	bid = `OUTER_SIDESET_ID`,
		const bool	calculate_origin = `true`,
		const Real	input_origin_x = `0.0`,
		const Real	input_origin_y = `0.0`,
		const Real	tol = `1.0E-10`
	)		const

protectedinherited

Collects sorted azimuthal angles of the external boundary.

Parameters

mesh	input mesh whose boundary node azimuthal angles need to be collected
boundary_points	reference vector to contain the Points corresponding to the collected azimuthal angles
lower_azi	lower boundary of the azimuthal angles to be collected
upper_azi	upper boundary of the azimuthal angles to be collected
return_type	whether angle values or tangent values are returned
num_sides	number of sides of the input mesh (only used if return type is ANGLE_TANGENT)
bid	id of the boundary of which the nodes' azimuthal angles are collected
calculate_origin	whether the mesh origin is calculated based on the centroid position
input_origin_x	precalculated mesh origin coordinate x
input_origin_y	precalculated mesh origin coordinate y
tol	tolerance that the minimum azimuthal angle is

Returns: the list of azimuthal angles of all the nodes on the external grain boundary within the given range

Definition at line 1417 of file PolygonMeshGeneratorBase.C.

{
  std::vector<std::tuple<dof_id_type, unsigned short int, boundary_id_type>> side_list =
      mesh.get_boundary_info().build_side_list();
  mesh.get_boundary_info().build_node_list_from_side_list();
  std::vector<std::tuple<dof_id_type, boundary_id_type>> node_list =
      mesh.get_boundary_info().build_node_list();
 
  std::vector<Real> bd_x_list;
  std::vector<Real> bd_y_list;
  std::vector<Point> bd_p_list;
  Real origin_x = 0.0;
  Real origin_y = 0.0;
  Real tmp_azi;
  const Real mid_azi = lower_azi <= upper_azi ? (lower_azi + upper_azi) / 2.0
                                              : (lower_azi + upper_azi + 360.0) / 2.0;
  for (unsigned int i = 0; i < node_list.size(); ++i)
    if (std::get<1>(node_list[i]) == bid)
    {
      bd_x_list.push_back((mesh.node_ref(std::get<0>(node_list[i])))(0));
      bd_y_list.push_back((mesh.node_ref(std::get<0>(node_list[i])))(1));
      bd_p_list.push_back((mesh.node_ref(std::get<0>(node_list[i]))));
    }
 
  if (calculate_origin)
  {
    const Point origin_pt = MooseMeshUtils::meshCentroidCalculator(mesh);
    origin_x = origin_pt(0);
    origin_y = origin_pt(1);
  }
  else
  {
    origin_x = input_origin_x;
    origin_y = input_origin_y;
  }
 
  std::vector<std::pair<Real, Point>> azi_point_pairs;
 
  for (unsigned int i = 0; i < bd_x_list.size(); ++i)
  {
    tmp_azi = atan2(bd_y_list[i] - origin_y, bd_x_list[i] - origin_x) * 180.0 / M_PI;
    if ((lower_azi <= upper_azi && (tmp_azi >= lower_azi - tol && tmp_azi <= upper_azi + tol)) ||
        (lower_azi > upper_azi && (tmp_azi >= lower_azi - tol || tmp_azi <= upper_azi + tol)))
    {
      azi_point_pairs.push_back(
          std::make_pair(return_type == ANGLE_DEGREE
                             ? (tmp_azi - mid_azi)
                             : (1.0 + std::cos(M_PI / num_sides) / std::sin(M_PI / num_sides) *
                                          std::tan((tmp_azi - mid_azi) / 180.0 * M_PI)),
                         bd_p_list[i]));
    }
  }
  std::sort(azi_point_pairs.begin(), azi_point_pairs.end());
 
  std::vector<Real> azimuthal_output;
  for (auto it = std::make_move_iterator(azi_point_pairs.begin()),
            end = std::make_move_iterator(azi_point_pairs.end());
       it != end;
       it++)
  {
    azimuthal_output.push_back(std::move(it->first));
    boundary_points.push_back(std::move(it->second));
  }
 
  return azimuthal_output;
}

Referenced by PolygonMeshGeneratorBase::azimuthalAnglesCollector(), AzimuthalBlockSplitGenerator::generate(), PatternedPolygonPeripheralModifierBase::generate(), and PolygonConcentricCircleMeshGeneratorBase::generate().

◆ backgroundNodes()

void PolygonMeshGeneratorBase::backgroundNodes	(	ReplicatedMesh &	mesh,
		const unsigned int	num_sectors_per_side,
		const unsigned int	background_intervals,
		const std::vector< Real >	biased_terms,
		const Real	background_corner_distance,
		const Real	background_corner_radial_interval_length,
		const Real	corner_p[2][2],
		const Real	corner_to_corner,
		const Real	background_in,
		const std::vector< Real >	azimuthal_tangent = `std::vector<Real>()`
	)		const

protectedinherited

Creates nodes for the ring-to-polygon transition region (i.e., background) of a single slice.

Parameters

mesh	input mesh to add the nodes onto
num_sectors_per_side	number of azimuthal intervals
background_intervals	number of radial intervals of the background region
biased_terms	normalized spacing values used for radial meshing biasing in background region
background_corner_distance	center to duct (innermost duct) corner distance
background_corner_radial_interval_length	radial interval distance
corner_p[2][2]	array contains the coordinates of the corner positions
corner_to_corner	diameter of the circumscribed circle of the polygon
background_in	radius of the inner boundary of the background region
azimuthal_tangent	vector of tangent values of the azimuthal angles as reference for adaptive boundary matching

Returns: a mesh with background region nodes created

Definition at line 718 of file PolygonMeshGeneratorBase.C.

{
  unsigned int angle_number =
      azimuthal_tangent.size() == 0 ? num_sectors_per_side : (azimuthal_tangent.size() - 1);
  for (unsigned int k = 0; k < (background_intervals); k++)
  {
    const Real background_corner_p_x =
        background_corner_distance / (0.5 * corner_to_corner) * corner_p[0][0] *
        (background_in +
         biased_terms[k] * background_intervals * background_corner_radial_interval_length) /
        background_corner_distance;
    const Real background_corner_p_y =
        background_corner_distance / (0.5 * corner_to_corner) * corner_p[0][1] *
        (background_in +
         biased_terms[k] * background_intervals * background_corner_radial_interval_length) /
        background_corner_distance;
 
    // background_corner_p(s) are the points in the background region, on the bins towards the six
    // corners, at different intervals
    mesh.add_point(Point(background_corner_p_x, background_corner_p_y, 0.0));
 
    for (unsigned int j = 1; j <= angle_number; j++)
    {
      const Real cell_boundary_p_x =
          background_corner_distance / (0.5 * corner_to_corner) *
          (corner_p[0][0] + (corner_p[1][0] - corner_p[0][0]) *
                                (azimuthal_tangent.size() == 0 ? ((Real)j / (Real)angle_number)
                                                               : (azimuthal_tangent[j] / 2.0)));
      const Real cell_boundary_p_y =
          background_corner_distance / (0.5 * corner_to_corner) *
          (corner_p[0][1] + (corner_p[1][1] - corner_p[0][1]) *
                                (azimuthal_tangent.size() == 0 ? ((Real)j / (Real)angle_number)
                                                               : (azimuthal_tangent[j] / 2.0)));
      // cell_boundary_p(s) are the points on the cell's six boundaries (flat sides) at different
      // azimuthal angles
      const Real pin_boundary_p_x =
          cell_boundary_p_x * background_in /
          std::sqrt(Utility::pow<2>(cell_boundary_p_x) + Utility::pow<2>(cell_boundary_p_y));
      const Real pin_boundary_p_y =
          cell_boundary_p_y * background_in /
          std::sqrt(Utility::pow<2>(cell_boundary_p_x) + Utility::pow<2>(cell_boundary_p_y));
      // pin_boundary_p(s) are the points on pin boundary (outside ring) at different azimuthal
      // angles
      const Real background_radial_interval =
          std::sqrt(Utility::pow<2>(cell_boundary_p_x - pin_boundary_p_x) +
                    Utility::pow<2>(cell_boundary_p_y - pin_boundary_p_y)) /
          background_intervals;
      const Real background_azimuthal_p_x =
          cell_boundary_p_x *
          (background_in + biased_terms[k] * background_intervals * background_radial_interval) /
          std::sqrt(Utility::pow<2>(cell_boundary_p_x) + Utility::pow<2>(cell_boundary_p_y));
      const Real background_azimuthal_p_y =
          cell_boundary_p_y *
          (background_in + biased_terms[k] * background_intervals * background_radial_interval) /
          std::sqrt(Utility::pow<2>(cell_boundary_p_x) + Utility::pow<2>(cell_boundary_p_y));
      // background_azimuthal_p are the points on the bins towards different azimuthal angles, at
      // different intervals; excluding the ones produced by background_corner_p
      mesh.add_point(Point(background_azimuthal_p_x, background_azimuthal_p_y, 0.0));
    }
  }
}

Referenced by PolygonMeshGeneratorBase::buildSlice().

◆ biasTermsCalculator() [1/2]

std::vector< Real > PolygonMeshGeneratorBase::biasTermsCalculator	(	const Real	radial_bias,
		const unsigned int	intervals,
		const singleBdryLayerParams	inner_boundary_layer_params = `{0.0, 0.0, 0, 1.0}`,
		const singleBdryLayerParams	outer_boundary_layer_params = `{0.0, 0.0, 0, 1.0}`
	)		const

protectedinherited

Creates bias terms for a single block.

Parameters

radial_bias	bias growth factor of the elements within the main region of the block
intervals	radial interval number of the main region of the block
inner_boundary_layer_params	width, radial fraction, radial sector, and growth factor of the inner boundary layer
outer_boundary_layer_params	width, radial fraction, radial sector, and growth factor of the outer boundary layer

Returns: bias terms describing the cumulative radial fractions of the nodes within a single block

Definition at line 1543 of file PolygonMeshGeneratorBase.C.

{
  // To get biased indices:
  // If no bias is involved, namely bias factor = 1.0, the increment in indices is uniform.
  // Thus, (i + 1) is used to get such linearly increasing indices.
  // If a non-trivial bias factor q is used, the increment in the indices is geometric
  // progression. So, if first (i = 0) increment is 1.0, second (i = 1) is q, third (i = 2) is
  // q^2,..., last or n_interval'th is q^(n_interval - 1). Then, the summation of the first (i +
  // 1) increments over the summation of all n_interval increments is the (i + 1)th index The
  // summation of the first (i + 1) increments is (1.0 - q^(i + 1)) / (1 - q); The summation of
  // all n_interval increments is (1.0 - q^n_interval) / (1 - q); Thus, the index is (1.0 - q^(i +
  // 1)) / (1.0 - q^n_interval)
  // This approach is used by inner boundary layer, main region, outer boundary layer separately.
 
  std::vector<Real> biased_terms;
  for (unsigned int i = 0; i < inner_boundary_layer_params.intervals; i++)
    biased_terms.push_back(
        MooseUtils::absoluteFuzzyEqual(inner_boundary_layer_params.bias, 1.0)
            ? ((Real)(i + 1) * inner_boundary_layer_params.fraction /
               (Real)inner_boundary_layer_params.intervals)
            : ((1.0 - std::pow(inner_boundary_layer_params.bias, (Real)(i + 1))) /
               (1.0 - std::pow(inner_boundary_layer_params.bias,
                               (Real)(inner_boundary_layer_params.intervals))) *
               inner_boundary_layer_params.fraction));
  for (unsigned int i = 0; i < intervals; i++)
    biased_terms.push_back(inner_boundary_layer_params.fraction +
                           (MooseUtils::absoluteFuzzyEqual(radial_bias, 1.0)
                                ? ((Real)(i + 1) *
                                   (1.0 - inner_boundary_layer_params.fraction -
                                    outer_boundary_layer_params.fraction) /
                                   (Real)intervals)
                                : ((1.0 - std::pow(radial_bias, (Real)(i + 1))) /
                                   (1.0 - std::pow(radial_bias, (Real)(intervals))) *
                                   (1.0 - inner_boundary_layer_params.fraction -
                                    outer_boundary_layer_params.fraction))));
  for (unsigned int i = 0; i < outer_boundary_layer_params.intervals; i++)
    biased_terms.push_back(
        1.0 - outer_boundary_layer_params.fraction +
        (MooseUtils::absoluteFuzzyEqual(outer_boundary_layer_params.bias, 1.0)
             ? ((Real)(i + 1) * outer_boundary_layer_params.fraction /
                (Real)outer_boundary_layer_params.intervals)
             : ((1.0 - std::pow(outer_boundary_layer_params.bias, (Real)(i + 1))) /
                (1.0 - std::pow(outer_boundary_layer_params.bias,
                                (Real)(outer_boundary_layer_params.intervals))) *
                outer_boundary_layer_params.fraction)));
  return biased_terms;
}

◆ biasTermsCalculator() [2/2]

std::vector< std::vector< Real > > PolygonMeshGeneratorBase::biasTermsCalculator	(	const std::vector< Real >	radial_biases,
		const std::vector< unsigned int >	intervals,
		const multiBdryLayerParams	inner_boundary_layer_params,
		const multiBdryLayerParams	outer_boundary_layer_params
	)		const

protectedinherited

Creates bias terms for multiple blocks.

Parameters

radial_biases	bias growth factors of the elements within the main regions of the blocks
intervals	radial interval numbers of the main regions of the blocks
inner_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the inner boundary layers
outer_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the outer boundary layers

Returns: bias list of terms describing the cumulative radial fractions of the nodes within multiple blocks

Definition at line 1521 of file PolygonMeshGeneratorBase.C.

{
  std::vector<std::vector<Real>> bias_terms_vec;
  for (unsigned int i = 0; i < radial_biases.size(); i++)
    bias_terms_vec.push_back(biasTermsCalculator(radial_biases[i],
                                                 intervals[i],
                                                 {0.0,
                                                  inner_boundary_layer_params.fractions[i],
                                                  inner_boundary_layer_params.intervals[i],
                                                  inner_boundary_layer_params.biases[i]},
                                                 {0.0,
                                                  outer_boundary_layer_params.fractions[i],
                                                  outer_boundary_layer_params.intervals[i],
                                                  outer_boundary_layer_params.biases[i]}));
  return bias_terms_vec;
}

Referenced by PolygonMeshGeneratorBase::biasTermsCalculator(), PolygonMeshGeneratorBase::buildSlice(), and generate().

◆ buildGeneralSlice()

std::unique_ptr< ReplicatedMesh > PolygonMeshGeneratorBase::buildGeneralSlice	(	std::vector< Real >	ring_radii,
		const std::vector< unsigned int >	ring_layers,
		const std::vector< Real >	ring_radial_biases,
		const multiBdryLayerParams &	ring_inner_boundary_layer_params,
		const multiBdryLayerParams &	ring_outer_boundary_layer_params,
		std::vector< Real >	ducts_center_dist,
		const std::vector< unsigned int >	ducts_layers,
		const std::vector< Real >	duct_radial_biases,
		const multiBdryLayerParams &	duct_inner_boundary_layer_params,
		const multiBdryLayerParams &	duct_outer_boundary_layer_params,
		const Real	primary_side_length,
		const Real	secondary_side_length,
		const unsigned int	num_sectors_per_side,
		const unsigned int	background_intervals,
		const Real	background_radial_bias,
		const singleBdryLayerParams &	background_inner_boundary_layer_params,
		const singleBdryLayerParams &	background_outer_boundary_layer_params,
		dof_id_type &	node_id_background_meta,
		const Real	azimuthal_angle,
		const std::vector< Real >	azimuthal_tangent,
		const unsigned int	side_index,
		const bool	quad_center_elements,
		const Real	center_quad_factor,
		const Real	rotation_angle,
		const bool	generate_side_specific_boundaries = `true`
	)

protectedinherited

Creates a mesh of a general polygon slice with a triangular shape and circular regions on one of its vertex.

Parameters

ring_radii	radii of the ring regions
ring_layers	numbers of radial intervals of the ring regions
ring_radial_biases	values used for radial meshing biasing in ring regions
ring_inner_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the inner boundary layer of the ring regions
ring_outer_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the outer boundary layer of the ring regions
ducts_center_dist	distance parameters of the duct regions
ducts_layers	numbers of radial intervals of the duct regions
duct_radial_biases	values used for radial meshing biasing in duct regions
duct_inner_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the inner boundary layer of the duct regions
duct_outer_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the outer boundary layer of the duct regions
primary_side_length	length of the first side (i.e., the side that is parallel to y-axis when rotation_angle is zero) that involves the ring center vertex
secondary_side_length	length of the second side (obtained by clockwise rotating the fist side by azimuthal_angle) that involves the ring center vertex
num_sectors_per_side	number of azimuthal intervals
background_intervals	number of radial intervals of the background region
background_radial_bias	value used for radial meshing biasing in background region
background_inner_boundary_layer_params	width, radial sectors, and growth factor of the inner boundary layer of the background region
background_outer_boundary_layer_params	width, radial sectors, and growth factor of the outer boundary layer of the background region
node_id_background_meta	pointer to the first node's id of the background region
azimuthal_angle	the angle defined by the primary and secondary sides
azimuthal_tangent	vector of tangent values of the azimuthal angles as reference for adaptive boundary matching
side_index	index of the polygon side
quad_center_elements	whether the central region contains quad elements or not
center_quad_factor	A fractional radius factor used to determine the radial positions of transition nodes in the center region meshed by quad elements (default is 1.0 - 1.0/div_num)
rotation_angle	azimuthal angle of the primary side
generate_side_specific_boundaries	whether the side-specific external boundaries are generated or not

Returns: a mesh of a general slice

Definition at line 40 of file PolygonMeshGeneratorBase.C.

{
  const Real virtual_pitch = 2.0 * primary_side_length * cos(azimuthal_angle / 360.0 * M_PI);
  const Real virtual_side_number = 360.0 / azimuthal_angle;
  const Real pitch_scale_factor = secondary_side_length / primary_side_length;
 
  auto mesh = buildSlice(ring_radii,
                         ring_layers,
                         ring_radial_biases,
                         ring_inner_boundary_layer_params,
                         ring_outer_boundary_layer_params,
                         ducts_center_dist,
                         ducts_layers,
                         duct_radial_biases,
                         duct_inner_boundary_layer_params,
                         duct_outer_boundary_layer_params,
                         virtual_pitch,
                         num_sectors_per_side,
                         background_intervals,
                         background_radial_bias,
                         background_inner_boundary_layer_params,
                         background_outer_boundary_layer_params,
                         node_id_background_meta,
                         virtual_side_number,
                         side_index,
                         azimuthal_tangent,
                         0,
                         quad_center_elements,
                         center_quad_factor,
                         false,
                         true,
                         0,
                         pitch_scale_factor,
                         generate_side_specific_boundaries);
  MeshTools::Modification::rotate(*mesh, rotation_angle, 0, 0);
  return mesh;
}

Referenced by TriPinHexAssemblyGenerator::buildSinglePinSection().

◆ buildSimplePeripheral()

std::unique_ptr< ReplicatedMesh > PolygonMeshGeneratorBase::buildSimplePeripheral	(	const unsigned int	num_sectors_per_side,
		const unsigned int	peripheral_invervals,
		const std::vector< std::pair< Real, Real > > &	position_inner,
		const std::vector< std::pair< Real, Real > > &	d_position_outer,
		const subdomain_id_type	id_shift,
		const QUAD_ELEM_TYPE	quad_elem_type,
		const bool	create_inward_interface_boundaries = `false`,
		const bool	create_outward_interface_boundaries = `true`
	)

protectedinherited

Creates peripheral area mesh for the patterned hexagon mesh.

Note that the function create the peripheral area for each side of the unit hexagon mesh before stitching. An edge unit hexagon has two sides that need peripheral areas, whereas a corner unit hexagon has three such sides. The positions of the inner and outer boundary nodes are pre-calculated as positions_inner and d_positions_outer; This function performs interpolation to generate the mesh grid.

Parameters

mesh	input mesh to create the peripheral area mesh onto
num_sectors_per_side	number of azimuthal intervals
peripheral_invervals	number of radial intervals of the peripheral region
position_inner	key positions of the inner side of the peripheral region
d_position_outer	key inremental positions of the outer side of the peripheral region
id_shift	shift of subdomain id of the peripheral region
create_inward_interface_boundaries	whether inward interface boundary sidesets are created
create_outward_interface_boundaries	whether outward interface boundary sidesets are created
quad_elem_type	type of quad element to be created

Returns: a mesh with the peripheral region added to a hexagon input mesh

Definition at line 1151 of file PolygonMeshGeneratorBase.C.

{
  auto mesh = buildReplicatedMesh(2);
  std::pair<Real, Real> positions_p;
 
  // generate node positions
  for (unsigned int i = 0; i <= peripheral_invervals; i++)
  {
    for (unsigned int j = 0; j <= num_sectors_per_side / 2; j++)
    {
      positions_p = pointInterpolate(positions_inner[0].first,
                                     positions_inner[0].second,
                                     d_positions_outer[0].first,
                                     d_positions_outer[0].second,
                                     positions_inner[1].first,
                                     positions_inner[1].second,
                                     d_positions_outer[1].first,
                                     d_positions_outer[1].second,
                                     i,
                                     j,
                                     num_sectors_per_side,
                                     peripheral_invervals);
      mesh->add_point(Point(positions_p.first, positions_p.second, 0.0));
    }
    for (unsigned int j = 1; j <= num_sectors_per_side / 2; j++)
    {
      positions_p = pointInterpolate(positions_inner[1].first,
                                     positions_inner[1].second,
                                     d_positions_outer[1].first,
                                     d_positions_outer[1].second,
                                     positions_inner[2].first,
                                     positions_inner[2].second,
                                     d_positions_outer[2].first,
                                     d_positions_outer[2].second,
                                     i,
                                     j,
                                     num_sectors_per_side,
                                     peripheral_invervals);
      mesh->add_point(Point(positions_p.first, positions_p.second, 0.0));
    }
  }
 
  // element definition
  BoundaryInfo & boundary_info = mesh->get_boundary_info();
 
  for (unsigned int i = 0; i < peripheral_invervals; i++)
  {
    for (unsigned int j = 0; j < num_sectors_per_side; j++)
    {
      std::unique_ptr<Elem> new_elem;
 
      new_elem = std::make_unique<Quad4>();
      new_elem->set_node(0, mesh->node_ptr(j + (num_sectors_per_side + 1) * (i)));
      new_elem->set_node(1, mesh->node_ptr(j + 1 + (num_sectors_per_side + 1) * (i)));
      new_elem->set_node(2, mesh->node_ptr(j + 1 + (num_sectors_per_side + 1) * (i + 1)));
      new_elem->set_node(3, mesh->node_ptr(j + (num_sectors_per_side + 1) * (i + 1)));
 
      Elem * elem = mesh->add_elem(std::move(new_elem));
 
      // add subdoamin and boundary IDs
      elem->subdomain_id() = PERIPHERAL_ID_SHIFT + id_shift;
      if (i == 0)
      {
        boundary_info.add_side(elem, 0, OUTER_SIDESET_ID);
        if (create_inward_interface_boundaries)
          boundary_info.add_side(elem, 0, SLICE_ALT + id_shift * 2);
      }
      if (i == peripheral_invervals - 1)
      {
        boundary_info.add_side(elem, 2, OUTER_SIDESET_ID);
        if (create_outward_interface_boundaries)
          boundary_info.add_side(elem, 2, SLICE_ALT + id_shift * 2 + 1);
      }
      if (j == 0)
        boundary_info.add_side(elem, 3, OUTER_SIDESET_ID);
      if (j == num_sectors_per_side - 1)
        boundary_info.add_side(elem, 1, OUTER_SIDESET_ID);
    }
  }
 
  // convert element to second order if needed
  if (quad_elem_type != QUAD_ELEM_TYPE::QUAD4)
  {
    // full_ordered 2nd order element --> QUAD9, otherwise QUAD8
    const bool full_ordered = (quad_elem_type == QUAD_ELEM_TYPE::QUAD9);
    mesh->all_second_order(full_ordered);
  }
 
  return mesh;
}

Referenced by PatternedCartesianMeshGenerator::addPeripheralMesh(), and PatternedHexMeshGenerator::addPeripheralMesh().

◆ buildSimpleSlice()

std::unique_ptr< ReplicatedMesh > PolygonMeshGeneratorBase::buildSimpleSlice	(	std::vector< Real >	ring_radii,
		const std::vector< unsigned int >	ring_layers,
		const std::vector< Real >	ring_radial_biases,
		const multiBdryLayerParams &	ring_inner_boundary_layer_params,
		const multiBdryLayerParams &	ring_outer_boundary_layer_params,
		std::vector< Real >	ducts_center_dist,
		const std::vector< unsigned int >	ducts_layers,
		const std::vector< Real >	duct_radial_biases,
		const multiBdryLayerParams &	duct_inner_boundary_layer_params,
		const multiBdryLayerParams &	duct_outer_boundary_layer_params,
		const Real	pitch,
		const unsigned int	num_sectors_per_side,
		const unsigned int	background_intervals,
		const Real	background_radial_bias,
		const singleBdryLayerParams &	background_inner_boundary_layer_params,
		const singleBdryLayerParams &	background_outer_boundary_layer_params,
		dof_id_type &	node_id_background_meta,
		const unsigned int	side_number,
		const unsigned int	side_index,
		const std::vector< Real >	azimuthal_tangent = `std::vector<Real>()`,
		const subdomain_id_type	block_id_shift = `0`,
		const bool	quad_center_elements = `false`,
		const Real	center_quad_factor = `0.0`,
		const bool	create_inward_interface_boundaries = `false`,
		const bool	create_outward_interface_boundaries = `true`,
		const boundary_id_type	boundary_id_shift = `0`,
		const bool	generate_side_specific_boundaries = `true`,
		const TRI_ELEM_TYPE	tri_elem_type = `TRI_ELEM_TYPE::TRI3`,
		const QUAD_ELEM_TYPE	quad_elem_type = `QUAD_ELEM_TYPE::QUAD4`
	)

protectedinherited

Creates a mesh of a slice that corresponds to a single side of the polygon to be generated.

Parameters

ring_radii	radii of the ring regions
ring_layers	numbers of radial intervals of the ring regions
ring_radial_biases	values used for radial meshing biasing in ring regions
ring_inner_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the inner boundary layer of the ring regions
ring_outer_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the outer boundary layer of the ring regions
ducts_center_dist	distance parameters of the duct regions
ducts_layers	numbers of radial intervals of the duct regions
duct_radial_biases	values used for radial meshing biasing in duct regions
duct_inner_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the inner boundary layer of the duct regions
duct_outer_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the outer boundary layer of the duct regions
pitch	twice the distance from the ring center vertex to the side defined by the other vertices
num_sectors_per_side	number of azimuthal intervals
background_intervals	number of radial intervals of the background region
background_radial_bias	value used for radial meshing biasing in background region
background_inner_boundary_layer_params	width, radial sectors, and growth factor of the inner boundary layer of the background region
background_outer_boundary_layer_params	width, radial sectors, and growth factor of the outer boundary layer of the background region
node_id_background_meta	pointer to the first node's id of the background region
side_number	number of sides of the polygon
side_index	index of the polygon side
azimuthal_tangent	vector of tangent values of the azimuthal angles as reference for adaptive boundary matching
block_id_shift	shift of the subdomain ids generated by this function
quad_center_elements	whether the central region contrains quad elements or not
center_quad_factor	A fractional radius factor used to determine the radial positions of transition nodes in the center region meshed by quad elements (default is 1.0 - 1.0/div_num)
create_inward_interface_boundaries	whether inward interface boundary sidesets are created
create_outward_interface_boundaries	whether outward interface boundary sidesets are created
boundary_id_shift	shift of the interface boundary ids
generate_side_specific_boundaries	whether the side-specific external boundaries are generated or not
tri_elem_type	type of the triangular elements to be generated
quad_elem_type	type of the quadrilateral elements to be generated

Returns: a mesh of a polygon slice

Definition at line 104 of file PolygonMeshGeneratorBase.C.

{
  return buildSlice(ring_radii,
                    ring_layers,
                    ring_radial_biases,
                    ring_inner_boundary_layer_params,
                    ring_outer_boundary_layer_params,
                    ducts_center_dist,
                    ducts_layers,
                    duct_radial_biases,
                    duct_inner_boundary_layer_params,
                    duct_outer_boundary_layer_params,
                    pitch,
                    num_sectors_per_side,
                    background_intervals,
                    background_radial_bias,
                    background_inner_boundary_layer_params,
                    background_outer_boundary_layer_params,
                    node_id_background_meta,
                    side_number,
                    side_index,
                    azimuthal_tangent,
                    block_id_shift,
                    quad_center_elements,
                    center_quad_factor,
                    create_inward_interface_boundaries,
                    create_outward_interface_boundaries,
                    boundary_id_shift,
                    1.0,
                    generate_side_specific_boundaries,
                    tri_elem_type,
                    quad_elem_type);
}

Referenced by PolygonConcentricCircleMeshGeneratorBase::generate().

◆ buildSlice()

std::unique_ptr< ReplicatedMesh > PolygonMeshGeneratorBase::buildSlice	(	std::vector< Real >	ring_radii,
		const std::vector< unsigned int >	ring_layers,
		const std::vector< Real >	ring_radial_biases,
		const multiBdryLayerParams &	ring_inner_boundary_layer_params,
		const multiBdryLayerParams &	ring_outer_boundary_layer_params,
		std::vector< Real >	ducts_center_dist,
		const std::vector< unsigned int >	ducts_layers,
		const std::vector< Real >	duct_radial_biases,
		const multiBdryLayerParams &	duct_inner_boundary_layer_params,
		const multiBdryLayerParams &	duct_outer_boundary_layer_params,
		const Real	pitch,
		const unsigned int	num_sectors_per_side,
		const unsigned int	background_intervals,
		const Real	background_radial_bias,
		const singleBdryLayerParams &	background_inner_boundary_layer_params,
		const singleBdryLayerParams &	background_outer_boundary_layer_params,
		dof_id_type &	node_id_background_meta,
		const Real	virtual_side_number,
		const unsigned int	side_index,
		const std::vector< Real >	azimuthal_tangent = `std::vector<Real>()`,
		const subdomain_id_type	block_id_shift = `0`,
		const bool	quad_center_elements = `false`,
		const Real	center_quad_factor = `0.0`,
		const bool	create_inward_interface_boundaries = `false`,
		const bool	create_outward_interface_boundaries = `true`,
		const boundary_id_type	boundary_id_shift = `0`,
		const Real	pitch_scale_factor = `1.0`,
		const bool	generate_side_specific_boundaries = `true`,
		const TRI_ELEM_TYPE	tri_elem_type = `TRI_ELEM_TYPE::TRI3`,
		const QUAD_ELEM_TYPE	quad_elem_type = `QUAD_ELEM_TYPE::QUAD4`
	)

protectedinherited

Generates a mesh of a polygon slice, which is the foundation of both buildGeneralSlice and buildSimpleSlice.

Parameters

ring_radii	radii of the ring regions
ring_layers	numbers of radial intervals of the ring regions
ring_radial_biases	values used for radial meshing biasing in ring regions
ring_inner_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the inner boundary layer of the ring regions
ring_outer_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the outer boundary layer of the ring regions
ducts_center_dist	distance parameters of the duct regions
ducts_layers	numbers of radial intervals of the duct regions
duct_radial_biases	values used for radial meshing biasing in duct regions
duct_inner_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the inner boundary layer of the duct regions
duct_outer_boundary_layer_params	widths, radial fractions, radial sectors, and growth factors of the outer boundary layer of the duct regions
pitch	twice of the length of the first side times cosine of the azimuthal angle
num_sectors_per_side	number of azimuthal intervals
background_intervals	number of radial intervals of the background region
background_radial_bias	value used for radial meshing biasing in background region
background_inner_boundary_layer_params	width, radial sectors, and growth factor of the inner boundary layer of the background region
background_outer_boundary_layer_params	width, radial sectors, and growth factor of the outer boundary layer of the background region
node_id_background_meta	pointer to the first node's id of the background region
virtual_side_number	360.0 over the azimuthal angle of the slice (happens to be number of sides of the polygon if a regular polygon is to be generated)
side_index	index of the polygon side
azimuthal_tangent	vector of tangent values of the azimuthal angles as reference for adaptive boundary matching
block_id_shift	shift of the subdomain ids generated by this function
quad_center_elements	whether the central region contrains quad elements or not
center_quad_factor	A fractional radius factor used to determine the radial positions of transition nodes in the center region meshed by quad elements (default is 1.0 - 1.0/div_num)
create_inward_interface_boundaries	whether inward interface boundary sidesets are created
create_outward_interface_boundaries	whether outward interface boundary sidesets are created
boundary_id_shift	shift of the interface boundary ids
pitch_scale_factor	the ratio between the secondary side length to the primary side length.
generate_side_specific_boundaries	whether the side-specific external boundaries are generated or not
tri_elem_type	type of the triangular elements to be generated
quad_elem_type	type of the quadrilateral elements to be generated

Returns: a mesh of a slice

Definition at line 168 of file PolygonMeshGeneratorBase.C.

{
  const unsigned short order = quad_elem_type == QUAD_ELEM_TYPE::QUAD4 ? 1 : 2;
  if (order != (tri_elem_type == TRI_ELEM_TYPE::TRI3 ? 1 : 2))
    mooseError("In mesh generator ",
               this->name(),
               ", an incompatible elements type combination is used when calling "
               "PolygonMeshGeneratorBase::buildSlice().");
  // In order to create quadratic elements (i.e., order = 2), we creates nodes with double mesh
  // density. Thus, the related parameters need to be modified accordingly. A prefix "mod_" is used
  // to indicate the modified parameters.
 
  // For ring_layers, modification is to double the number of layers for order = 2
  std::vector<unsigned int> mod_ring_layers(ring_layers);
  std::for_each(
      mod_ring_layers.begin(), mod_ring_layers.end(), [&order](unsigned int & n) { n *= order; });
  // For ring_radial_biases, modification is to take the square root of the original biases for
  // order = 2
  std::vector<Real> mod_ring_radial_biases(ring_radial_biases);
  std::for_each(mod_ring_radial_biases.begin(),
                mod_ring_radial_biases.end(),
                [&order](Real & n) { n = std::pow(n, 1.0 / order); });
  // ducts_layers is similar to ring_layers
  std::vector<unsigned int> mod_ducts_layers(ducts_layers);
  std::for_each(
      mod_ducts_layers.begin(), mod_ducts_layers.end(), [&order](unsigned int & n) { n *= order; });
  // duct_radial_biases is similar to ring_radial_biases
  std::vector<Real> mod_duct_radial_biases(duct_radial_biases);
  std::for_each(mod_duct_radial_biases.begin(),
                mod_duct_radial_biases.end(),
                [&order](Real & n) { n = std::pow(n, 1.0 / order); });
  // Azimuthal mesh density is also doubled for order = 2
  const unsigned int mod_num_sectors_per_side = num_sectors_per_side * order;
  const unsigned int mod_background_intervals = background_intervals * order;
  // background_radial_bias is similar to ring_radial_biases
  const Real mod_background_radial_bias = std::pow(background_radial_bias, 1.0 / order);
  // Perform similar modifications for boundary layer parameters
  const auto mod_ring_inner_boundary_layer_params =
      modifiedMultiBdryLayerParamsCreator(ring_inner_boundary_layer_params, order);
  const auto mod_ring_outer_boundary_layer_params =
      modifiedMultiBdryLayerParamsCreator(ring_outer_boundary_layer_params, order);
  const auto mod_duct_inner_boundary_layer_params =
      modifiedMultiBdryLayerParamsCreator(duct_inner_boundary_layer_params, order);
  const auto mod_duct_outer_boundary_layer_params =
      modifiedMultiBdryLayerParamsCreator(duct_outer_boundary_layer_params, order);
 
  const auto mod_background_inner_boundary_layer_params =
      modifiedSingleBdryLayerParamsCreator(background_inner_boundary_layer_params, order);
  const auto mod_background_outer_boundary_layer_params =
      modifiedSingleBdryLayerParamsCreator(background_outer_boundary_layer_params, order);
 
  // The distance parameters of the rings and duct need to be modified too as they may be involved
  // in the boundary layer cases.
  std::vector<Real> mod_ducts_center_dist(ducts_center_dist);
  std::vector<Real> mod_ring_radii(ring_radii);
  bool has_rings(ring_radii.size());
  bool has_ducts(ducts_center_dist.size());
  bool has_background(background_intervals);
  auto mesh = buildReplicatedMesh(2);
 
  // Calculate biasing terms
  // background region needs to be split into three parts
  const auto main_background_bias_terms =
      biasTermsCalculator(background_radial_bias, background_intervals);
  const auto inner_background_bias_terms =
      biasTermsCalculator(background_inner_boundary_layer_params.bias,
                          background_inner_boundary_layer_params.intervals);
  const auto outer_background_bias_terms =
      biasTermsCalculator(background_outer_boundary_layer_params.bias,
                          background_outer_boundary_layer_params.intervals);
  auto rings_bias_terms = biasTermsCalculator(ring_radial_biases,
                                              ring_layers,
                                              ring_inner_boundary_layer_params,
                                              ring_outer_boundary_layer_params);
  auto duct_bias_terms = biasTermsCalculator(duct_radial_biases,
                                             ducts_layers,
                                             duct_inner_boundary_layer_params,
                                             duct_outer_boundary_layer_params);
  // Equivalent "mod_" parts
  const auto mod_main_background_bias_terms =
      biasTermsCalculator(mod_background_radial_bias, mod_background_intervals);
  const auto mod_inner_background_bias_terms =
      biasTermsCalculator(mod_background_inner_boundary_layer_params.bias,
                          mod_background_inner_boundary_layer_params.intervals);
  const auto mod_outer_background_bias_terms =
      biasTermsCalculator(mod_background_outer_boundary_layer_params.bias,
                          mod_background_outer_boundary_layer_params.intervals);
  auto mod_rings_bias_terms = biasTermsCalculator(mod_ring_radial_biases,
                                                  mod_ring_layers,
                                                  mod_ring_inner_boundary_layer_params,
                                                  mod_ring_outer_boundary_layer_params);
  auto mod_duct_bias_terms = biasTermsCalculator(mod_duct_radial_biases,
                                                 mod_ducts_layers,
                                                 mod_duct_inner_boundary_layer_params,
                                                 mod_duct_outer_boundary_layer_params);
 
  std::vector<unsigned int> total_ring_layers;
  for (unsigned int i = 0; i < ring_layers.size(); i++)
    total_ring_layers.push_back(ring_layers[i] + ring_inner_boundary_layer_params.intervals[i] +
                                ring_outer_boundary_layer_params.intervals[i]);
 
  if (background_inner_boundary_layer_params.intervals)
  {
    total_ring_layers.push_back(background_inner_boundary_layer_params.intervals);
    rings_bias_terms.push_back(inner_background_bias_terms);
    ring_radii.push_back((ring_radii.empty() ? 0.0 : ring_radii.back()) +
                         background_inner_boundary_layer_params.width);
    has_rings = true;
  }
  std::vector<unsigned int> mod_total_ring_layers;
  for (unsigned int i = 0; i < mod_ring_layers.size(); i++)
    mod_total_ring_layers.push_back(mod_ring_layers[i] +
                                    mod_ring_inner_boundary_layer_params.intervals[i] +
                                    mod_ring_outer_boundary_layer_params.intervals[i]);
 
  if (mod_background_inner_boundary_layer_params.intervals)
  {
    mod_total_ring_layers.push_back(mod_background_inner_boundary_layer_params.intervals);
    mod_rings_bias_terms.push_back(mod_inner_background_bias_terms);
    mod_ring_radii.push_back((mod_ring_radii.empty() ? 0.0 : mod_ring_radii.back()) +
                             mod_background_inner_boundary_layer_params.width);
    // has_rings should be modified before in the none "mod_" part
  }
 
  std::vector<unsigned int> total_ducts_layers;
  if (background_outer_boundary_layer_params.intervals)
  {
    total_ducts_layers.push_back(background_outer_boundary_layer_params.intervals);
    duct_bias_terms.insert(duct_bias_terms.begin(), outer_background_bias_terms);
    ducts_center_dist.insert(ducts_center_dist.begin(),
                             (ducts_center_dist.empty()
                                  ? pitch / 2.0 / std::cos(M_PI / virtual_side_number)
                                  : ducts_center_dist.front()) -
                                 background_outer_boundary_layer_params.width);
    has_ducts = true;
  }
  for (unsigned int i = 0; i < ducts_layers.size(); i++)
    total_ducts_layers.push_back(ducts_layers[i] + duct_inner_boundary_layer_params.intervals[i] +
                                 duct_outer_boundary_layer_params.intervals[i]);
 
  std::vector<unsigned int> mod_total_ducts_layers;
  if (mod_background_outer_boundary_layer_params.intervals)
  {
    mod_total_ducts_layers.push_back(mod_background_outer_boundary_layer_params.intervals);
    mod_duct_bias_terms.insert(mod_duct_bias_terms.begin(), mod_outer_background_bias_terms);
    mod_ducts_center_dist.insert(mod_ducts_center_dist.begin(),
                                 (mod_ducts_center_dist.empty()
                                      ? pitch / 2.0 / std::cos(M_PI / virtual_side_number)
                                      : mod_ducts_center_dist.front()) -
                                     mod_background_outer_boundary_layer_params.width);
    // has_ducts should be modified before in the none "mod_" part
  }
  for (unsigned int i = 0; i < mod_ducts_layers.size(); i++)
    mod_total_ducts_layers.push_back(mod_ducts_layers[i] +
                                     mod_duct_inner_boundary_layer_params.intervals[i] +
                                     mod_duct_outer_boundary_layer_params.intervals[i]);
 
  unsigned int angle_number = azimuthal_tangent.size() == 0
                                  ? num_sectors_per_side
                                  : ((azimuthal_tangent.size() - 1) / order);
  unsigned int mod_angle_number =
      azimuthal_tangent.size() == 0 ? mod_num_sectors_per_side : (azimuthal_tangent.size() - 1);
 
  // Geometries
  const Real corner_to_corner =
      pitch / std::cos(M_PI / virtual_side_number); // distance of bin center to cell corner
  const Real corner_p[2][2] = {
      {0.0, 0.5 * corner_to_corner},
      {0.5 * corner_to_corner * pitch_scale_factor * std::sin(2.0 * M_PI / virtual_side_number),
       0.5 * corner_to_corner * pitch_scale_factor * std::cos(2.0 * M_PI / virtual_side_number)}};
  const unsigned int div_num = angle_number / 2 + 1;
  const unsigned int mod_div_num = mod_angle_number / 2 + 1;
 
  // From now on, we work on the nodes, which need the "mod_" parameters
  std::vector<std::vector<Node *>> nodes(mod_div_num, std::vector<Node *>(mod_div_num));
  if (quad_center_elements)
  {
    Real ring_radii_0;
 
    if (has_rings)
      ring_radii_0 = ring_radii.front() * mod_rings_bias_terms.front()[order - 1];
    else if (has_ducts)
      ring_radii_0 = mod_ducts_center_dist.front() * std::cos(M_PI / virtual_side_number) *
                     mod_main_background_bias_terms[order - 1];
    else
      ring_radii_0 = pitch / 2.0 * mod_main_background_bias_terms[order - 1];
    // If center_quad_factor is zero, default value (div_num - 1)/div_num  is used.
    // We use div_num instead of mod_div_num because we are dealing wth elements here
    // This approach ensures that the order = 2 mesh elements are consistent with the order = 1
    ring_radii_0 *=
        center_quad_factor == 0.0 ? (((Real)div_num - 1.0) / (Real)div_num) : center_quad_factor;
 
    centerNodes(*mesh, virtual_side_number, mod_div_num, ring_radii_0, nodes);
  }
  else // pin-cell center
    mesh->add_point(Point(0.0, 0.0, 0.0));
 
  // create nodes for the ring regions
  if (has_rings)
    ringNodes(*mesh,
              ring_radii,
              mod_total_ring_layers,
              mod_rings_bias_terms,
              mod_num_sectors_per_side,
              corner_p,
              corner_to_corner,
              azimuthal_tangent);
 
  if (has_background)
  {
    // add nodes in background region; the background region is defined as the area between the
    // outermost pin (if there is a pin; if no pin, the center) and the innermost hex/duct; if
    // _has_ducts is false, the background region is the area between the pin and enclosing hexagon
    Real background_corner_radial_interval_length;
    Real background_corner_distance;
    Real background_in;
    Real background_out; // background outer frontier
    if (has_rings)
      background_in = ring_radii.back();
    else
      background_in = 0;
 
    if (has_ducts)
    {
      background_out = mod_ducts_center_dist.front();
      background_corner_distance =
          mod_ducts_center_dist
              .front(); // it is the center to duct (innermost duct) corner distance
    }
    else
    {
      background_out = 0.5 * corner_to_corner;
      background_corner_distance =
          0.5 * corner_to_corner; // it is the center to hex corner distance
    }
 
    background_corner_radial_interval_length =
        (background_out - background_in) / mod_background_intervals;
 
    node_id_background_meta = mesh->n_nodes();
 
    // create nodes for background region
    backgroundNodes(*mesh,
                    mod_num_sectors_per_side,
                    mod_background_intervals,
                    mod_main_background_bias_terms,
                    background_corner_distance,
                    background_corner_radial_interval_length,
                    corner_p,
                    corner_to_corner,
                    background_in,
                    azimuthal_tangent);
  }
 
  // create nodes for duct regions
  if (has_ducts)
    ductNodes(*mesh,
              &mod_ducts_center_dist,
              mod_total_ducts_layers,
              mod_duct_bias_terms,
              mod_num_sectors_per_side,
              corner_p,
              corner_to_corner,
              azimuthal_tangent);
 
  // See if the central region is the only part of the innermost part
  // The central region of the slice is special.
  // Unlike the outer regions, which are layered quad elements,
  // the central region is either a layer of tri elements or a specially-patterned quad elements.
  // If there is at least one `ring` defined in the slice,
  // the central region must belong to the innermost (first) ring.
  // Otherwise the central region belongs to the `background`
  // In either case, if the innermost ring or background has only one radial interval,
  // the central region is an independent ring or background
  // Otherwise, the central region and one or several quad element layers together form the
  // innermost ring or background
  bool is_central_region_independent;
  if (ring_layers.empty())
    is_central_region_independent = mod_background_inner_boundary_layer_params.intervals +
                                        mod_background_intervals +
                                        mod_background_outer_boundary_layer_params.intervals ==
                                    1;
  else
    is_central_region_independent = mod_ring_layers[0] +
                                        mod_ring_inner_boundary_layer_params.intervals[0] +
                                        mod_ring_outer_boundary_layer_params.intervals[0] ==
                                    1;
 
  // From now on, we work on the elements, which need the none "mod_" parameters
  // Assign elements, boundaries, and subdomains;
  // Add Tri3/Tri6/Tri7 or Quad4/Quad8/Quad9 mesh into innermost (central) region
  if (quad_center_elements)
    cenQuadElemDef(*mesh,
                   div_num,
                   block_id_shift,
                   create_outward_interface_boundaries && is_central_region_independent,
                   boundary_id_shift,
                   nodes,
                   (!has_rings) && (!has_ducts) && (background_intervals == 1),
                   // Note here, has_ring means either there are ring regions or background inner
                   // boundary layer; has_ducts means either there are duct regions or background
                   // outer boundary layer. Same in cenTriElemDef()
                   side_index,
                   generate_side_specific_boundaries,
                   quad_elem_type);
  else
    cenTriElemDef(
        *mesh,
        num_sectors_per_side,
        azimuthal_tangent,
        block_id_shift,
        create_outward_interface_boundaries && is_central_region_independent,
        boundary_id_shift,
        ((!has_rings) && (!has_ducts) && (background_intervals == 1)) ||
            ((!has_background) &&
             (std::accumulate(total_ring_layers.begin(), total_ring_layers.end(), 0) == 1)),
        // Only for ACCG, it is possible that the entire mesh is a single-layer ring.
        // cenQuadElemDef() does not need this as it does not work for ACCG.
        side_index,
        generate_side_specific_boundaries,
        tri_elem_type);
 
  // Add Quad4 mesh into outer circle
  // total number of mesh should be all the rings for pin regions + background regions;
  // total number of quad mesh should be total number of mesh -1 (-1 is because the inner circle for
  // tri/quad mesh has been added above)
 
  std::vector<unsigned int> subdomain_rings;
  if (has_rings) //  define the rings in each subdomain
  {
    subdomain_rings = total_ring_layers;
    subdomain_rings.front() -= 1; // remove the inner TRI mesh subdomain
    if (background_inner_boundary_layer_params.intervals)
    {
      subdomain_rings.back() =
          background_inner_boundary_layer_params.intervals + background_intervals +
          background_outer_boundary_layer_params.intervals; // add the background region
      if (ring_radii.size() == 1)
        subdomain_rings.back() -= 1; // remove the inner TRI mesh subdomain
    }
    else if (has_background)
      subdomain_rings.push_back(background_inner_boundary_layer_params.intervals +
                                background_intervals +
                                background_outer_boundary_layer_params.intervals);
  }
  else
  {
    subdomain_rings.push_back(
        background_inner_boundary_layer_params.intervals + background_intervals +
        background_outer_boundary_layer_params.intervals); // add the background region
    subdomain_rings[0] -= 1;                               // remove the inner TRI mesh subdomain
  }
 
  if (has_ducts)
    for (unsigned int i = (background_outer_boundary_layer_params.intervals > 0);
         i < total_ducts_layers.size();
         i++)
      subdomain_rings.push_back(total_ducts_layers[i]);
 
  quadElemDef(*mesh,
              num_sectors_per_side,
              subdomain_rings,
              side_index,
              azimuthal_tangent,
              block_id_shift,
              quad_center_elements ? (mod_div_num * mod_div_num - 1) : 0,
              create_inward_interface_boundaries,
              create_outward_interface_boundaries,
              boundary_id_shift,
              generate_side_specific_boundaries,
              quad_elem_type);
  if (tri_elem_type == TRI_ELEM_TYPE::TRI6 || quad_elem_type == QUAD_ELEM_TYPE::QUAD8)
    mesh->remove_orphaned_nodes();
  return mesh;
}

Referenced by PolygonMeshGeneratorBase::buildGeneralSlice(), PolygonMeshGeneratorBase::buildSimpleSlice(), and AdvancedConcentricCircleGenerator::generate().

◆ cenQuadElemDef()

void PolygonMeshGeneratorBase::cenQuadElemDef	(	ReplicatedMesh &	mesh,
		const unsigned int	div_num,
		const subdomain_id_type	block_id_shift,
		const bool	create_outward_interface_boundaries,
		const boundary_id_type	boundary_id_shift,
		std::vector< std::vector< Node * > > &	nodes,
		const bool	assign_external_boundary = `false`,
		const unsigned int	side_index = `0`,
		const bool	generate_side_specific_boundaries = `true`,
		const QUAD_ELEM_TYPE	quad_elem_type = `QUAD_ELEM_TYPE::QUAD4`
	)		const

protectedinherited

Defines quad elements in the very central region of the polygon.

Parameters

mesh	input mesh to create the elements onto
div_num	division number of the central mesh layer
block_id_shift	shift of the subdomain ids generated by this function
create_outward_interface_boundaries	whether outward interface boundary sidesets are created
boundary_id_shift	shift of the interface boundary ids
id_array	pointer to a vector that contains the node_ids with basic geometry information
assign_external_boundary	whether the external boundary ids are assigned
side_index	index of the polygon side (only used if external boundary ids are assigned)
generate_side_specific_boundaries	whether the side-specific external boundaries are generated or not
quad_elem_type	type of the quadrilateral elements to be generated

Definition at line 851 of file PolygonMeshGeneratorBase.C.

{
 
  BoundaryInfo & boundary_info = mesh.get_boundary_info();
 
  // This loop defines quad elements for the central regions except for the outermost layer
  for (unsigned int i = 0; i < div_num - 1; i++)
  {
    unsigned int id_x = 0;
    unsigned int id_y = i;
    for (unsigned int j = 0; j < 2 * i + 1; j++)
    {
      std::unique_ptr<Elem> new_elem;
      if (quad_elem_type == QUAD_ELEM_TYPE::QUAD4)
      {
        new_elem = std::make_unique<Quad4>();
        new_elem->set_node(0, nodes[id_x][id_y]);
        new_elem->set_node(3, nodes[id_x][id_y + 1]);
        new_elem->set_node(2, nodes[id_x + 1][id_y + 1]);
        new_elem->set_node(1, nodes[id_x + 1][id_y]);
        new_elem->subdomain_id() = 1 + block_id_shift;
      }
      else // QUAD8/QUAD9
      {
        new_elem = std::make_unique<Quad8>();
        if (quad_elem_type == QUAD_ELEM_TYPE::QUAD9)
        {
          new_elem = std::make_unique<Quad9>();
          new_elem->set_node(8, nodes[id_x * 2 + 1][id_y * 2 + 1]);
        }
        new_elem->set_node(0, nodes[id_x * 2][id_y * 2]);
        new_elem->set_node(3, nodes[id_x * 2][id_y * 2 + 2]);
        new_elem->set_node(2, nodes[id_x * 2 + 2][id_y * 2 + 2]);
        new_elem->set_node(1, nodes[id_x * 2 + 2][id_y * 2]);
        new_elem->set_node(4, nodes[id_x * 2 + 1][id_y * 2]);
        new_elem->set_node(5, nodes[id_x * 2 + 2][id_y * 2 + 1]);
        new_elem->set_node(6, nodes[id_x * 2 + 1][id_y * 2 + 2]);
        new_elem->set_node(7, nodes[id_x * 2][id_y * 2 + 1]);
        new_elem->subdomain_id() = 1 + block_id_shift;
      }
      Elem * elem_Quad = mesh.add_elem(std::move(new_elem));
 
      if (id_x == 0)
        boundary_info.add_side(elem_Quad, 3, SLICE_BEGIN);
      if (id_y == 0)
        boundary_info.add_side(elem_Quad, 0, SLICE_END);
      if (j < i)
        id_x++;
      if (j >= i)
        id_y--;
    }
  }
  // This loop defines the outermost layer quad elements of the central region
  for (unsigned int i = (div_num - 1) * (div_num - 1); i < div_num * div_num - 1; i++)
  {
    std::unique_ptr<Elem> new_elem;
    if (quad_elem_type == QUAD_ELEM_TYPE::QUAD4)
    {
      new_elem = std::make_unique<Quad4>();
      new_elem->set_node(0, mesh.node_ptr(i));
      new_elem->set_node(3, mesh.node_ptr(i + 2 * div_num - 1));
      new_elem->set_node(2, mesh.node_ptr(i + 2 * div_num));
      new_elem->set_node(1, mesh.node_ptr(i + 1));
    }
    else // QUAD8/QUAD9
    {
      new_elem = std::make_unique<Quad8>();
      if (quad_elem_type == QUAD_ELEM_TYPE::QUAD9)
      {
        new_elem = std::make_unique<Quad9>();
        new_elem->set_node(8,
                           mesh.node_ptr((div_num - 1) * (div_num - 1) * 4 +
                                         (i - (div_num - 1) * (div_num - 1)) * 2 + 1 +
                                         ((div_num - 1) * 4 + 1)));
      }
      new_elem->set_node(0,
                         mesh.node_ptr((div_num - 1) * (div_num - 1) * 4 +
                                       (i - (div_num - 1) * (div_num - 1)) * 2));
      new_elem->set_node(3,
                         mesh.node_ptr((div_num - 1) * (div_num - 1) * 4 +
                                       (i - (div_num - 1) * (div_num - 1)) * 2 +
                                       ((div_num - 1) * 4 + 1) * 2));
      new_elem->set_node(2,
                         mesh.node_ptr((div_num - 1) * (div_num - 1) * 4 +
                                       (i - (div_num - 1) * (div_num - 1)) * 2 + 2 +
                                       ((div_num - 1) * 4 + 1) * 2));
      new_elem->set_node(1,
                         mesh.node_ptr((div_num - 1) * (div_num - 1) * 4 +
                                       (i - (div_num - 1) * (div_num - 1)) * 2 + 2));
      new_elem->set_node(4,
                         mesh.node_ptr((div_num - 1) * (div_num - 1) * 4 +
                                       (i - (div_num - 1) * (div_num - 1)) * 2 + 1));
      new_elem->set_node(5,
                         mesh.node_ptr((div_num - 1) * (div_num - 1) * 4 +
                                       (i - (div_num - 1) * (div_num - 1)) * 2 + 2 +
                                       ((div_num - 1) * 4 + 1)));
      new_elem->set_node(6,
                         mesh.node_ptr((div_num - 1) * (div_num - 1) * 4 +
                                       (i - (div_num - 1) * (div_num - 1)) * 2 + 1 +
                                       ((div_num - 1) * 4 + 1) * 2));
      new_elem->set_node(7,
                         mesh.node_ptr((div_num - 1) * (div_num - 1) * 4 +
                                       (i - (div_num - 1) * (div_num - 1)) * 2 +
                                       ((div_num - 1) * 4 + 1)));
    }
 
    Elem * elem_Quad = mesh.add_elem(std::move(new_elem));
    elem_Quad->subdomain_id() = 1 + block_id_shift;
    if (create_outward_interface_boundaries)
      boundary_info.add_side(elem_Quad, 2, 1 + boundary_id_shift);
    if (i == (div_num - 1) * (div_num - 1))
      boundary_info.add_side(elem_Quad, 3, SLICE_BEGIN);
    if (i == div_num * div_num - 2)
      boundary_info.add_side(elem_Quad, 1, SLICE_END);
    if (assign_external_boundary)
    {
      boundary_info.add_side(elem_Quad, 2, OUTER_SIDESET_ID);
      if (generate_side_specific_boundaries)
        boundary_info.add_side(
            elem_Quad,
            2,
            (i < div_num * (div_num - 1) ? OUTER_SIDESET_ID : OUTER_SIDESET_ID_ALT) + side_index);
    }
  }
}

Referenced by PolygonMeshGeneratorBase::buildSlice().

◆ centerNodes()

void PolygonMeshGeneratorBase::centerNodes	(	ReplicatedMesh &	mesh,
		const Real	virtual_side_number,
		const unsigned int	div_num,
		const Real	ring_radii_0,
		std::vector< std::vector< Node * > > &	nodes
	)		const

protectedinherited

Creates nodes of the very central mesh layer of the polygon for quad central elements.

Parameters

mesh	input mesh to add the nodes onto
virtual_side_number	virtual number of sides of the polygon (360/slice_azimuthal)
div_num	division number of the central mesh layer
ring_radii_0	radius of the central mesh layer
nodes	pointer to the mesh's nodes
nodes	vector that contains the nodes with basic geometry information

Definition at line 575 of file PolygonMeshGeneratorBase.C.

{
  const std::pair<Real, Real> p_origin = std::make_pair(0.0, 0.0);
  const std::pair<Real, Real> p_bottom =
      std::make_pair(0.0, ring_radii_0 * std::cos(M_PI / virtual_side_number));
  const std::pair<Real, Real> p_top =
      std::make_pair(p_bottom.second * std::sin(2.0 * M_PI / virtual_side_number),
                     p_bottom.second * std::cos(2.0 * M_PI / virtual_side_number));
  const std::pair<Real, Real> p_diag =
      std::make_pair(ring_radii_0 * std::sin(M_PI / virtual_side_number),
                     ring_radii_0 * std::cos(M_PI / virtual_side_number));
 
  // The four vertices of the central quad region are defined above.
  // The following loops transverse all the nodes within this central quad region by moving p1 thru
  // p4 and calculate the four-point intercept (pc).
  //  p_top------o-------p4--------o-----p_diag
  //    |        |        |        |        |
  //    |        |        |        |        |
  //    o--------o--------o--------o--------o
  //    |        |        |        |        |
  //    |        |        |        |        |
  //   p1--------o-------pc--------o-------p2
  //    |        |        |        |        |
  //    |        |        |        |        |
  //    o--------o--------o--------o--------o
  //    |        |        |        |        |
  //    |        |        |        |        |
  // p_origin-----o-------p3--------o----p_bottom
  //
  // The loops are designed to transverse the nodes as shown below to facilitate elements
  // and sides creation.
  //
  //   25-------24-------23-------22-------21
  //    |        |        |        |        |
  //    |        |        |        |        |
  //   16-------15-------14-------13-------20
  //    |        |        |        |        |
  //    |        |        |        |        |
  //    9--------8------- 7-------12-------19
  //    |        |        |        |        |
  //    |        |        |        |        |
  //    4--------3--------6-------11-------18
  //    |        |        |        |        |
  //    |        |        |        |        |
  //    1--------2--------5-------10-------17
 
  for (unsigned int i = 0; i < div_num; i++)
  {
    unsigned int id_x = 0;
    unsigned int id_y = i;
    for (unsigned int j = 0; j < 2 * i + 1; j++)
    {
      std::pair<Real, Real> p1 = std::make_pair(
          (p_origin.first * (div_num - 1 - id_x) + p_top.first * id_x) / (div_num - 1),
          (p_origin.second * (div_num - 1 - id_x) + p_top.second * id_x) / (div_num - 1));
      std::pair<Real, Real> p2 = std::make_pair(
          (p_bottom.first * (div_num - 1 - id_x) + p_diag.first * id_x) / (div_num - 1),
          (p_bottom.second * (div_num - 1 - id_x) + p_diag.second * id_x) / (div_num - 1));
      std::pair<Real, Real> p3 = std::make_pair(
          (p_origin.first * (div_num - 1 - id_y) + p_bottom.first * id_y) / (div_num - 1),
          (p_origin.second * (div_num - 1 - id_y) + p_bottom.second * id_y) / (div_num - 1));
      std::pair<Real, Real> p4 = std::make_pair(
          (p_top.first * (div_num - 1 - id_y) + p_diag.first * id_y) / (div_num - 1),
          (p_top.second * (div_num - 1 - id_y) + p_diag.second * id_y) / (div_num - 1));
      std::pair<Real, Real> pc = fourPointIntercept(p1, p2, p3, p4);
      nodes[id_x][id_y] = mesh.add_point(Point(pc.first, pc.second, 0.0));
      if (j < i)
        id_x++;
      if (j >= i)
        id_y--;
    }
  }
}

Referenced by PolygonMeshGeneratorBase::buildSlice().

◆ cenTriElemDef()

void PolygonMeshGeneratorBase::cenTriElemDef	(	ReplicatedMesh &	mesh,
		const unsigned int	num_sectors_per_side,
		const std::vector< Real >	azimuthal_tangent = `std::vector<Real>()`,
		const subdomain_id_type	block_id_shift = `0`,
		const bool	create_outward_interface_boundaries = `true`,
		const boundary_id_type	boundary_id_shift = `0`,
		const bool	assign_external_boundary = `false`,
		const unsigned int	side_index = `0`,
		const bool	generate_side_specific_boundaries = `true`,
		const TRI_ELEM_TYPE	tri_elem_type = `TRI_ELEM_TYPE::TRI3`
	)		const

protectedinherited

Defines triangular elements in the very central region of the polygon.

Parameters

mesh	input mesh to create the elements onto
num_sectors_per_side	number of azimuthal intervals
azimuthal_tangent	vector of tangent values of the azimuthal angles as reference for adaptive boundary matching
block_id_shift	shift of the subdomain ids generated by this function
create_outward_interface_boundaries	whether outward interface boundary sidesets are created
boundary_id_shift	shift of the interface boundary ids
assign_external_boundary	whether the external boundary ids are assigned
side_index	index of the polygon side (only used if external boundary ids are assigned)
generate_side_specific_boundaries	whether the side-specific external boundaries are generated or not
tri_elem_type	type of the triangular elements to be generated

Definition at line 987 of file PolygonMeshGeneratorBase.C.

{
  const unsigned short order = tri_elem_type == TRI_ELEM_TYPE::TRI3 ? 1 : 2;
  unsigned int angle_number = azimuthal_tangent.size() == 0
                                  ? num_sectors_per_side
                                  : ((azimuthal_tangent.size() - 1) / order);
 
  BoundaryInfo & boundary_info = mesh.get_boundary_info();
  for (unsigned int i = 1; i <= angle_number; i++)
  {
    std::unique_ptr<Elem> new_elem;
    if (tri_elem_type == TRI_ELEM_TYPE::TRI3)
    {
      new_elem = std::make_unique<Tri3>();
      new_elem->set_node(0, mesh.node_ptr(0));
      new_elem->set_node(2, mesh.node_ptr(i));
      new_elem->set_node(1, mesh.node_ptr(i + 1));
    }
    else // TRI6/TRI7
    {
      new_elem = std::make_unique<Tri6>();
      if (tri_elem_type == TRI_ELEM_TYPE::TRI7)
      {
        new_elem = std::make_unique<Tri7>();
        new_elem->set_node(6, mesh.node_ptr(i * 2));
      }
      new_elem->set_node(0, mesh.node_ptr(0));
      new_elem->set_node(2, mesh.node_ptr(i * 2 + angle_number * order));
      new_elem->set_node(1, mesh.node_ptr((i + 1) * 2 + angle_number * order));
      new_elem->set_node(3, mesh.node_ptr(i * 2 + 1));
      new_elem->set_node(5, mesh.node_ptr(i * 2 - 1));
      new_elem->set_node(4, mesh.node_ptr(i * 2 + 1 + angle_number * order));
    }
 
    Elem * elem = mesh.add_elem(std::move(new_elem));
    if (create_outward_interface_boundaries)
      boundary_info.add_side(elem, 1, 1 + boundary_id_shift);
    elem->subdomain_id() = 1 + block_id_shift;
    if (i == 1)
      boundary_info.add_side(elem, 2, SLICE_BEGIN);
    if (i == angle_number)
      boundary_info.add_side(elem, 0, SLICE_END);
    if (assign_external_boundary)
    {
      boundary_info.add_side(elem, 1, OUTER_SIDESET_ID);
      if (generate_side_specific_boundaries)
        boundary_info.add_side(elem,
                               1,
                               (i <= angle_number / 2 ? OUTER_SIDESET_ID : OUTER_SIDESET_ID_ALT) +
                                   side_index);
    }
  }
}

Referenced by PolygonMeshGeneratorBase::buildSlice().

◆ cutOffPolyDeform()

void PolygonMeshGeneratorBase::cutOffPolyDeform	(	MeshBase &	mesh,
		const Real	orientation,
		const Real	y_max_0,
		const Real	y_max_n,
		const Real	y_min,
		const unsigned int	mesh_type,
		const Real	unit_angle = `60.0`,
		const Real	tols = `1E-5`
	)		const

protectedinherited

Deforms peripheral region when the external side of a polygon assembly of stitched meshes cuts off the stitched meshes.

Parameters

mesh	input mesh to be deformed
orientation	orientation angle of the input mesh (move the deformation direction to y)
y_max_0	original maximum y position
y_max_n	maximum y position after deformation
y_min	minimum y position that is affected by the deformation
mesh_type	whether the peripheral region is for a corner or a side hexagon mesh.
tols	tolerance used to determine the boundary of deformation region
unit_angle	unit angle of the geometry, which is 60.0 for hexagonal and 90.0 for square

Returns: n/a (input mesh is directly altered)

Definition at line 1327 of file PolygonMeshGeneratorBase.C.

{
  for (auto & node_ptr : as_range(mesh.nodes_begin(), mesh.nodes_end()))
  {
    // This function can definitely be optimized in future for better efficiency.
    Real & x = (*node_ptr)(0);
    Real & y = (*node_ptr)(1);
    if (mesh_type == CORNER_MESH)
    {
      nodeCoordRotate(x, y, orientation);
      if (x >= 0.0 && y > y_max_0)
        y = y - y_max_0 + y_max_n;
      else if (x >= 0.0 && y >= y_min)
        y = (y - y_min) / (y_max_0 - y_min) * (y_max_n - y_min) + y_min;
      else if (y > -x / std::tan(unit_angle / 360.0 * M_PI) + tols && y > y_max_0)
      {
        x /= y;
        y = y - y_max_0 + y_max_n;
        x *= y;
      }
      else if (y > -x / std::tan(unit_angle / 360.0 * M_PI) + tols && y >= y_min)
      {
        x /= y;
        y = (y - y_min) / (y_max_0 - y_min) * (y_max_n - y_min) + y_min;
        x *= y;
      }
      nodeCoordRotate(x, y, -orientation);
 
      nodeCoordRotate(x, y, orientation - unit_angle);
      if (x <= 0 && y > y_max_0)
        y = y - y_max_0 + y_max_n;
      else if (x <= 0 && y >= y_min)
        y = (y - y_min) / (y_max_0 - y_min) * (y_max_n - y_min) + y_min;
      else if (y >= x / std::tan(unit_angle / 360.0 * M_PI) - tols && y > y_max_0)
      {
        x /= y;
        y = y - y_max_0 + y_max_n;
        x *= y;
      }
      else if (y >= x / std::tan(unit_angle / 360.0 * M_PI) - tols && y >= y_min)
      {
        x /= y;
        y = (y - y_min) / (y_max_0 - y_min) * (y_max_n - y_min) + y_min;
        x *= y;
      }
      nodeCoordRotate(x, y, unit_angle - orientation);
    }
    else
    {
      nodeCoordRotate(x, y, orientation);
      if (y > y_max_0)
        y = y - y_max_0 + y_max_n;
      else if (y >= y_min)
        y = (y - y_min) / (y_max_0 - y_min) * (y_max_n - y_min) + y_min;
      nodeCoordRotate(x, y, -orientation);
    }
  }
}

Referenced by PatternedCartesianMeshGenerator::generate(), and PatternedHexMeshGenerator::generate().

◆ ductNodes()

void PolygonMeshGeneratorBase::ductNodes	(	ReplicatedMesh &	mesh,
		std::vector< Real > *const	ducts_center_dist,
		const std::vector< unsigned int >	ducts_layers,
		const std::vector< std::vector< Real > >	biased_terms,
		const unsigned int	num_sectors_per_side,
		const Real	corner_p[2][2],
		const Real	corner_to_corner,
		const std::vector< Real >	azimuthal_tangent = `std::vector<Real>()`
	)		const

protectedinherited

Creates nodes for the duct-geometry region of a single slice.

Parameters

mesh	input mesh to add the nodes onto
ducts_center_dist	distance parameters of the duct regions
ducts_layers	numbers of radial intervals of the duct regions
biased_terms	normalized spacing values used for radial meshing biasing in duct region
num_sectors_per_side	number of azimuthal intervals
corner_p[2][2]	array contains the coordinates of the corner positions
corner_to_corner	diameter of the circumscribed circle of the polygon
azimuthal_tangent	vector of tangent values of the azimuthal angles as reference for adaptive boundary matching

Definition at line 790 of file PolygonMeshGeneratorBase.C.

{
  unsigned int angle_number =
      azimuthal_tangent.size() == 0 ? num_sectors_per_side : (azimuthal_tangent.size() - 1);
  // Add nodes in ducts regions
  (*ducts_center_dist)
      .push_back(0.5 * corner_to_corner); // add hex boundary as the last element in this vector
  std::vector<Real> duct_radius_interval_length(ducts_layers.size());
 
  Real bin_radial_distance;
  for (unsigned int l = 0; l < ducts_layers.size(); l++)
  {
    duct_radius_interval_length[l] =
        ((*ducts_center_dist)[l + 1] - (*ducts_center_dist)[l]) /
        ducts_layers[l]; // the pin radius interval for each ring_radii/subdomain
 
    // add rings in each pin subdomain
    for (unsigned int k = 0; k < ducts_layers[l]; k++)
    {
      bin_radial_distance = ((*ducts_center_dist)[l] +
                             biased_terms[l][k] * ducts_layers[l] * duct_radius_interval_length[l]);
      const Real pin_corner_p_x = corner_p[0][0] * bin_radial_distance / (0.5 * corner_to_corner);
      const Real pin_corner_p_y = corner_p[0][1] * bin_radial_distance / (0.5 * corner_to_corner);
 
      // pin_corner_p(s) are the points in the pin region, on the bins towards the six corners,
      // at different intervals
      mesh.add_point(Point(pin_corner_p_x, pin_corner_p_y, 0.0));
 
      for (unsigned int j = 1; j <= angle_number; j++)
      {
        const Real cell_boundary_p_x =
            corner_p[0][0] + (corner_p[1][0] - corner_p[0][0]) *
                                 (azimuthal_tangent.size() == 0 ? ((Real)j / (Real)angle_number)
                                                                : (azimuthal_tangent[j] / 2.0));
        const Real cell_boundary_p_y =
            corner_p[0][1] + (corner_p[1][1] - corner_p[0][1]) *
                                 (azimuthal_tangent.size() == 0 ? ((Real)j / (Real)angle_number)
                                                                : (azimuthal_tangent[j] / 2.0));
        // cell_boundary_p(s) are the points on the cell's six boundaries (flat sides) at
        // different azimuthal angles
        const Real pin_azimuthal_p_x =
            cell_boundary_p_x * bin_radial_distance / (0.5 * corner_to_corner);
        const Real pin_azimuthal_p_y =
            cell_boundary_p_y * bin_radial_distance / (0.5 * corner_to_corner);
 
        // pin_azimuthal_p are the points on the bins towards different azimuthal angles, at
        // different intervals; excluding the ones produced by pin_corner_p
        mesh.add_point(Point(pin_azimuthal_p_x, pin_azimuthal_p_y, 0.0));
      }
    }
  }
}

Referenced by PolygonMeshGeneratorBase::buildSlice().

◆ fourPointIntercept()

std::pair< Real, Real > PolygonMeshGeneratorBase::fourPointIntercept	(	const std::pair< Real, Real > &	p1,
		const std::pair< Real, Real > &	p2,
		const std::pair< Real, Real > &	p3,
		const std::pair< Real, Real > &	p4
	)		const

protectedinherited

Finds the center of a quadrilateral based on four vertices.

Parameters

p1	vertex 1
p2	vertex 2
p3	vertex 3
p4	vertex 4

Returns: the intecept point coordinate x and y

Definition at line 1394 of file PolygonMeshGeneratorBase.C.

{
  const Real x1 = p1.first;
  const Real y1 = p1.second;
  const Real x2 = p2.first;
  const Real y2 = p2.second;
  const Real x3 = p3.first;
  const Real y3 = p3.second;
  const Real x4 = p4.first;
  const Real y4 = p4.second;
 
  Real x = -((x1 - x2) * (y3 * x4 - x3 * y4) - (x3 - x4) * (y1 * x2 - x1 * y2)) /
           ((y1 - y2) * (x3 - x4) - (y3 - y4) * (x1 - x2));
  Real y = -((y1 - y2) * (y3 * x4 - x3 * y4) - (y3 - y4) * (y1 * x2 - x1 * y2)) /
           ((y1 - y2) * (x3 - x4) - (y3 - y4) * (x1 - x2));
 
  return std::make_pair(x, y);
}

Referenced by PolygonMeshGeneratorBase::centerNodes(), and AzimuthalBlockSplitGenerator::nodeModifier().

◆ generate()

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

overridevirtual

Reimplemented from PolygonMeshGeneratorBase.

Definition at line 145 of file PeripheralRingMeshGenerator.C.

{
  if (hasMeshProperty<bool>("hexagon_center_trimmability", _input_name))
    setMeshProperty("hexagon_center_trimmability",
                    getMeshProperty<bool>("hexagon_center_trimmability", _input_name));
  if (hasMeshProperty<bool>("square_center_trimmability", _input_name))
    setMeshProperty("square_center_trimmability",
                    getMeshProperty<bool>("square_center_trimmability", _input_name));
 
  // Need ReplicatedMesh for stitching
  auto input_mesh = dynamic_cast<ReplicatedMesh *>(_input.get());
  if (!input_mesh)
    paramError("input", "Input is not a replicated mesh, which is required.");
 
  if (!input_mesh->preparation().has_cached_elem_data)
    input_mesh->cache_elem_data();
  if (*(input_mesh->elem_dimensions().begin()) != 2 ||
      *(input_mesh->elem_dimensions().rbegin()) != 2)
    paramError("input", "Only 2D meshes are supported.");
 
  _input_mesh_external_bid =
      MooseMeshUtils::getBoundaryID(_input_mesh_external_boundary, *input_mesh);
  if (!MooseMeshUtils::hasBoundaryNameOrID(*input_mesh, _input_mesh_external_boundary))
    paramError("input_mesh_external_boundary",
               "External boundary does not exist in the input mesh");
  // We check the element types of input mesh's external boundary here.
  // We support both linear and quadratic sides (i.e., EDGE2 and EDGE3), but we cannot support mixed
  // sides
  auto side_list_tmp = input_mesh->get_boundary_info().build_side_list();
  bool linear_side = false;
  bool quadratic_side = false;
  for (const auto & side : side_list_tmp)
  {
    if (std::get<2>(side) == _input_mesh_external_bid)
    {
      const auto etype = input_mesh->elem_ptr(std::get<0>(side))->side_type(std::get<1>(side));
      if (etype == EDGE2)
        linear_side = true;
      else if (etype == EDGE3)
        quadratic_side = true;
      else
        paramError("input", "Input contains elements that are not supported by this generator.");
    }
  }
  if (linear_side && quadratic_side)
    paramError("input", "Input contains mixed element types on the external boundary.");
  const unsigned int order = linear_side ? 1 : 2;
  if (order == 2)
  {
    _peripheral_outer_boundary_layer_params.bias =
        std::sqrt(_peripheral_outer_boundary_layer_params.bias);
    _peripheral_inner_boundary_layer_params.bias =
        std::sqrt(_peripheral_inner_boundary_layer_params.bias);
    _peripheral_outer_boundary_layer_params.intervals *= 2;
    _peripheral_inner_boundary_layer_params.intervals *= 2;
    _peripheral_radial_bias = std::sqrt(_peripheral_radial_bias);
  }
 
  // Move the centroid of the mesh to (0, 0, 0) if input centroid is enforced to be the ring center.
  const Point input_mesh_centroid = MooseMeshUtils::meshCentroidCalculator(*input_mesh);
  if (_force_input_centroid_as_center)
    MeshTools::Modification::translate(
        *input_mesh, -input_mesh_centroid(0), -input_mesh_centroid(1), -input_mesh_centroid(2));
 
  // Use CoM of the input mesh as its origin for azimuthal calculation
  const Point origin_pt =
      _force_input_centroid_as_center ? Point(0.0, 0.0, 0.0) : input_mesh_centroid;
  // Vessel for containing maximum radius of the boundary nodes
  Real max_input_mesh_node_radius;
 
  // Calculate biasing terms
  // For 2nd order mesh, as we need the mid points, the bias factor is square rooted.
  const auto main_peripheral_bias_terms =
      biasTermsCalculator(_peripheral_radial_bias, _peripheral_layer_num * order);
  const auto inner_peripheral_bias_terms =
      biasTermsCalculator(_peripheral_inner_boundary_layer_params.bias,
                          _peripheral_inner_boundary_layer_params.intervals);
  // It is easier to create outer boundary layer inversely (inwards). Thus, 1.0 / bias is used here.
  // However, the input parameter definition is not affected.
  const auto outer_peripheral_bias_terms =
      biasTermsCalculator(1.0 / _peripheral_outer_boundary_layer_params.bias,
                          _peripheral_outer_boundary_layer_params.intervals);
 
  const unsigned int total_peripheral_layer_num =
      _peripheral_inner_boundary_layer_params.intervals + _peripheral_layer_num * order +
      _peripheral_outer_boundary_layer_params.intervals;
 
  // Collect the external boundary nodes of the input mesh using the utility function
  std::vector<dof_id_type> boundary_ordered_node_list;
  try
  {
    FillBetweenPointVectorsTools::isBoundarySimpleClosedLoop(*input_mesh,
                                                             max_input_mesh_node_radius,
                                                             boundary_ordered_node_list,
                                                             origin_pt,
                                                             _input_mesh_external_bid);
  }
  catch (MooseException & e)
  {
    if (((std::string)e.what()).compare("The node list provided has more than one segments.") == 0)
      paramError("input_mesh_external_boundary",
                 "This mesh generator does not work for the provided external boundary as it has "
                 "more than one segments.");
    else
      paramError("input_mesh_external_boundary", e.what());
  }
 
  if (max_input_mesh_node_radius >= _peripheral_ring_radius)
    paramError(
        "peripheral_ring_radius",
        "The peripheral ring to be generated must be large enough to cover the entire input mesh.");
  if (!FillBetweenPointVectorsTools::isExternalBoundary(*input_mesh, _input_mesh_external_bid))
    paramError("input_mesh_external_boundary",
               "The boundary provided is not an external boundary.");
 
  std::vector<Point> input_ext_bd_pts;
  std::vector<Point> output_ext_bd_pts;
  std::vector<std::tuple<Real, Point, Point>> azi_points;
  std::vector<Real> azi_array;
  Real tmp_azi(0.0);
  auto mesh = buildReplicatedMesh(2);
 
  // Node counter for the external boundary
  unsigned int input_ext_node_num = 0;
 
  // As the node list collected before is a simple closed loop, the last node is the same as the
  // first node. We remove it here.
  boundary_ordered_node_list.pop_back();
  // Loop over all the boundary nodes
  // For quadratic sides, the middle points are included automatically
  for (const auto i : index_range(boundary_ordered_node_list))
  {
    input_ext_node_num++;
    // Define nodes on the inner and outer boundaries of the peripheral region.
    input_ext_bd_pts.push_back(input_mesh->point(boundary_ordered_node_list[i]));
    tmp_azi =
        atan2(input_ext_bd_pts.back()(1) - origin_pt(1), input_ext_bd_pts.back()(0) - origin_pt(0));
    output_ext_bd_pts.push_back(Point(_peripheral_ring_radius * std::cos(tmp_azi),
                                      _peripheral_ring_radius * std::sin(tmp_azi),
                                      origin_pt(2)));
    // a vector of tuples using azimuthal angle as the key to facilitate sorting
    azi_points.push_back(
        std::make_tuple(tmp_azi, input_ext_bd_pts.back(), output_ext_bd_pts.back()));
    // a simple vector of azimuthal angles for radius correction purposes (in degree)
    azi_array.push_back(tmp_azi / M_PI * 180.0);
  }
  // Only for quadratic sides, if the index of the first node after sorting is even, it is a vertex
  // node; otherwise, it is a midpoint node.
  const bool is_first_node_vertex =
      order == 1 ||
      !(std::distance(azi_array.begin(), std::min_element(azi_array.begin(), azi_array.end())) % 2);
  std::sort(azi_points.begin(), azi_points.end());
  std::sort(azi_array.begin(), azi_array.end());
 
  // Angles defined by three neighboring nodes on input mesh's external boundary
  std::vector<Real> input_bdry_angles;
  // Normal directions of input boundary nodes
  std::vector<Point> input_bdry_nd;
  for (const auto i : index_range(azi_points))
  {
    Point p1, p2;
    const Point pn = Point(0.0, 0.0, 1.0);
    if (i == 0)
    {
      p1 = std::get<1>(azi_points[i + 1]) - std::get<1>(azi_points[i]);
      p2 = std::get<1>(azi_points.back()) - std::get<1>(azi_points[i]);
    }
    else if (i == azi_points.size() - 1)
    {
      p1 = std::get<1>(azi_points.front()) - std::get<1>(azi_points.back());
      p2 = std::get<1>(azi_points[i - 1]) - std::get<1>(azi_points.back());
    }
    else
    {
      p1 = std::get<1>(azi_points[i + 1]) - std::get<1>(azi_points[i]);
      p2 = std::get<1>(azi_points[i - 1]) - std::get<1>(azi_points[i]);
    }
    // Use cross point to get perpendicular direction
    const Point p1n = (p1.cross(pn)).unit();
    const Point p2n = -(p2.cross(pn)).unit();
    Real tmp = p1 * p2 / p1.norm() / p2.norm();
    // Make sure acos() gets valid input
    tmp = tmp > 1.0 ? 1.0 : (tmp < -1.0 ? -1.0 : tmp);
    input_bdry_angles.push_back(acos(tmp) / 2.0);
    input_bdry_nd.push_back((p1n + p2n).unit());
  }
 
  // 2D vector containing all the node positions of the peripheral region
  std::vector<std::vector<Point>> points_array(total_peripheral_layer_num + 1,
                                               std::vector<Point>(input_ext_node_num));
  // 2D vector containing all the node ids of the peripheral region
  std::vector<std::vector<dof_id_type>> node_id_array(total_peripheral_layer_num + 1,
                                                      std::vector<dof_id_type>(input_ext_node_num));
  // Reference outmost layer of inner boundary layer
  std::vector<Point> ref_inner_bdry_surf;
  // First loop
  for (const auto i : make_range(input_ext_node_num))
  {
    // Inner boundary nodes of the peripheral region
    points_array[0][i] = std::get<1>(azi_points[i]);
    // Define outer layer of inner boundary layer
    if (_peripheral_inner_boundary_layer_params.intervals)
    {
      // Outside point of the inner boundary layer
      const Point ref_inner_boundary_shift =
          (_peripheral_inner_boundary_layer_params.width / sin(input_bdry_angles[i])) *
          input_bdry_nd[i];
      ref_inner_bdry_surf.push_back(points_array[0][i] + ref_inner_boundary_shift);
    }
  }
 
  if (_peripheral_inner_boundary_layer_params.intervals)
    innerBdryLayerNodesDefiner(input_ext_node_num,
                               input_bdry_angles,
                               ref_inner_bdry_surf,
                               inner_peripheral_bias_terms,
                               azi_array,
                               origin_pt,
                               points_array);
  const Real correction_factor = _preserve_volumes
                                     ? PolygonalMeshGenerationUtils::radiusCorrectionFactor(
                                           azi_array, true, order, is_first_node_vertex)
                                     : 1.0;
  // Loop to handle outer boundary layer and main region
  for (const auto i : make_range(input_ext_node_num))
  {
    // Outer boundary nodes of the peripheral region
    points_array[total_peripheral_layer_num][i] = std::get<2>(azi_points[i]) * correction_factor;
    // Outer boundary layer points
    if (_peripheral_outer_boundary_layer_params.intervals)
    {
      // Inner point of the outer boundary layer
      const Point outer_boundary_shift =
          -Point(std::cos(std::get<0>(azi_points[i])), std::sin(std::get<0>(azi_points[i])), 0.0) *
          _peripheral_outer_boundary_layer_params.width;
      for (const auto j :
           make_range(uint(1), _peripheral_outer_boundary_layer_params.intervals + 1))
        points_array[total_peripheral_layer_num - j][i] =
            points_array[total_peripheral_layer_num][i] +
            outer_boundary_shift * outer_peripheral_bias_terms[j - 1];
    }
    // Use interpolation to get main region
    if (MooseUtils::absoluteFuzzyGreaterEqual(
            (points_array[_peripheral_inner_boundary_layer_params.intervals][i] - origin_pt).norm(),
            (points_array[_peripheral_inner_boundary_layer_params.intervals +
                          _peripheral_layer_num * order][i] -
             origin_pt)
                .norm()))
    {
      paramError("peripheral_inner_boundary_layer_width",
                 "The summation of peripheral_inner_boundary_layer_width and "
                 "peripheral_outer_boundary_layer_width must be smaller than the thickness of "
                 "peripheral ring region.");
    }
 
    for (const auto j : make_range(uint(1), _peripheral_layer_num * order))
      points_array[j + _peripheral_inner_boundary_layer_params.intervals][i] =
          points_array[_peripheral_inner_boundary_layer_params.intervals][i] *
              (1.0 - main_peripheral_bias_terms[j - 1]) +
          points_array[_peripheral_inner_boundary_layer_params.intervals +
                       _peripheral_layer_num * order][i] *
              main_peripheral_bias_terms[j - 1];
  }
  unsigned int num_total_nodes = (total_peripheral_layer_num + 1) * input_ext_node_num;
  std::vector<Node *> nodes(num_total_nodes); // reserve nodes pointers
  dof_id_type node_id = 0;
 
  // Add nodes to the new mesh
  for (const auto i : make_range(total_peripheral_layer_num + 1))
    for (const auto j : make_range(input_ext_node_num))
    {
      nodes[node_id] = mesh->add_point(points_array[i][j], node_id);
      node_id_array[i][j] = node_id;
      node_id++;
    }
  // Add elements to the new mesh
  BoundaryInfo & boundary_info = mesh->get_boundary_info();
  const unsigned int index_shift = is_first_node_vertex ? 0 : 1;
  for (const auto i : make_range(total_peripheral_layer_num / order))
    for (const auto j : make_range(input_ext_node_num / order))
    {
      std::unique_ptr<Elem> new_elem;
      new_elem = std::make_unique<Quad4>();
      if (order == 2)
      {
        new_elem = std::make_unique<Quad9>();
        new_elem->set_node(4, nodes[node_id_array[i * order + 1][j * order + index_shift]]);
        new_elem->set_node(5,
                           nodes[node_id_array[(i + 1) * order][(j * order + 1 + index_shift) %
                                                                input_ext_node_num]]);
        new_elem->set_node(6,
                           nodes[node_id_array[i * order + 1][((j + 1) * order + index_shift) %
                                                              input_ext_node_num]]);
        new_elem->set_node(
            7, nodes[node_id_array[i * order][(j * order + 1 + index_shift) % input_ext_node_num]]);
        new_elem->set_node(8,
                           nodes[node_id_array[i * order + 1][(j * order + 1 + index_shift) %
                                                              input_ext_node_num]]);
      }
      new_elem->set_node(0, nodes[node_id_array[i * order][j * order + index_shift]]);
      new_elem->set_node(1, nodes[node_id_array[(i + 1) * order][j * order + index_shift]]);
      new_elem->set_node(2,
                         nodes[node_id_array[(i + 1) * order][((j + 1) * order + index_shift) %
                                                              input_ext_node_num]]);
      new_elem->set_node(
          3, nodes[node_id_array[i * order][((j + 1) * order + index_shift) % input_ext_node_num]]);
      new_elem->subdomain_id() = _peripheral_ring_block_id;
 
      Elem * added_elem = mesh->add_elem(std::move(new_elem));
 
      if (i == 0)
        boundary_info.add_side(added_elem, 3, OUTER_SIDESET_ID_ALT);
      if (i == total_peripheral_layer_num / order - 1)
        boundary_info.add_side(added_elem, 1, OUTER_SIDESET_ID);
    }
 
  // This would make sure that the boundary OUTER_SIDESET_ID is deleted after stitching.
  if (_input_mesh_external_bid != OUTER_SIDESET_ID)
    MooseMesh::changeBoundaryId(*input_mesh, _input_mesh_external_bid, OUTER_SIDESET_ID, false);
  mesh->prepare_for_use();
  // Use input_mesh here to retain the subdomain name map
  input_mesh->stitch_meshes(*mesh, OUTER_SIDESET_ID, OUTER_SIDESET_ID_ALT, TOLERANCE, true, false);
 
  // Assign subdomain name to the new block if applicable
  if (isParamValid("peripheral_ring_block_name"))
    input_mesh->set_subdomain_name(_peripheral_ring_block_id, _peripheral_ring_block_name, true);
  // Assign customized external boundary id
  if (_external_boundary_id > 0)
    MooseMesh::changeBoundaryId(*input_mesh, OUTER_SIDESET_ID, _external_boundary_id, false);
  // Assign customized external boundary name
  if (!_external_boundary_name.empty())
  {
    input_mesh->get_boundary_info().sideset_name(
        _external_boundary_id > 0 ? _external_boundary_id : (boundary_id_type)OUTER_SIDESET_ID) =
        _external_boundary_name;
    input_mesh->get_boundary_info().nodeset_name(
        _external_boundary_id > 0 ? _external_boundary_id : (boundary_id_type)OUTER_SIDESET_ID) =
        _external_boundary_name;
  }
 
  _input->unset_is_prepared();
  return dynamic_pointer_cast<MeshBase>(_input);
}

◆ getInterfaceBoundaryIDs()

std::set< boundary_id_type > PolygonMeshGeneratorBase::getInterfaceBoundaryIDs	(	const std::vector< std::vector< unsigned int > > &	pattern,
		const std::vector< std::vector< boundary_id_type > > &	interface_boundary_id_shift_pattern,
		const std::set< boundary_id_type > &	boundary_ids,
		const std::vector< std::set< boundary_id_type > > &	input_interface_boundary_ids,
		const bool	use_interface_boundary_id_shift,
		const bool	create_interface_boundary_id,
		const unsigned int	num_extra_layers
	)		const

protectedinherited

returns a list of interface boundary IDs on the mesh generated by this mesh generator

Parameters

pattern	pattern of cells used in this mesh generator
interface_boundary_id_shift_pattern	2D pattern of shift values applied to the boundary IDs inside each pattern cells
boundary_ids	list of boundary IDs on the mesh generated by this mesh generator
input_interface_boundary_ids	list of interface boundary IDs of the pattern cells
use_interface_boundary_id_shift	whether ID shifts are applied to interface boundary IDs of the pattern cells
create_interface_boundary_id	whether interface boundary IDs are generated by this mesh generator
num_extra_layers	number of extra layers to define background and duct regions on the patterned mesh generated by this mesh generator

Definition at line 1720 of file PolygonMeshGeneratorBase.C.

{
  std::set<boundary_id_type> interface_boundary_ids;
  // add existing interface boundary ids from input meshes
  if (use_interface_boundary_id_shift)
  {
    for (const auto i : make_range(pattern.size()))
      for (const auto j : make_range(pattern[i].size()))
      {
        const auto & ids = input_interface_boundary_ids[pattern[i][j]];
        for (const auto & id : ids)
        {
          const boundary_id_type new_id = id + interface_boundary_id_shift_pattern[i][j];
          auto it = boundary_ids.find(new_id);
          if (it != boundary_ids.end())
            interface_boundary_ids.insert(new_id);
        }
      }
  }
  else
  {
    for (const auto & ids : input_interface_boundary_ids)
      for (const auto & id : ids)
      {
        auto it = boundary_ids.find(id);
        if (it != boundary_ids.end())
          interface_boundary_ids.insert(id);
      }
  }
  // add unshifted interface boundary ids for the duct & background regions
  if (create_interface_boundary_id)
    for (const auto i : make_range(num_extra_layers))
    {
      boundary_id_type id = SLICE_ALT + i * 2 + 1;
      auto it = boundary_ids.find(id);
      if (it != boundary_ids.end())
        interface_boundary_ids.insert(id);
      id = SLICE_ALT + i * 2;
      it = boundary_ids.find(id);
      if (it != boundary_ids.end())
        interface_boundary_ids.insert(id);
    }
  return interface_boundary_ids;
}

Referenced by PatternedCartesianMeshGenerator::generate(), and PatternedHexMeshGenerator::generate().

◆ innerBdryLayerNodesDefiner()

void PeripheralRingMeshGenerator::innerBdryLayerNodesDefiner	(	const unsigned int	input_ext_node_num,
		const std::vector< Real >	input_bdry_angles,
		const std::vector< Point >	ref_inner_bdry_surf,
		const std::vector< Real >	inner_peripheral_bias_terms,
		const std::vector< Real >	azi_array,
		const Point	origin_pt,
		std::vector< std::vector< Point > > &	points_array
	)		const

protected

Define node positions of the inner boundary layer that is conformal to the input mesh's external boundary.

Parameters

input_ext_node_num	number of nodes on the external boundary of the input mesh
input_bdry_angles	list of angles (in rad) formed by three neighboring nodes on the external boundary of the input mesh
ref_inner_bdry_surf	reference outmost layer (surface) points of the inner boundary layer
inner_peripheral_bias_terms	terms describing the cumulative radial fractions of the nodes within the inner boundary layer
azi_array	list of azimuthal angles (in degrees) of the nodes on the input mesh's external boundary for radius correction purpose
origin_pt	centroid of the input mesh, which is used as the origin
points_array	container to store all nodes' positions of the peripheral ring region

Definition at line 490 of file PeripheralRingMeshGenerator.C.

{
  // Check if any azimuthal angles are messed after inner boundary layer addition
  std::vector<bool> delete_mark(input_ext_node_num, false);
  std::vector<Real> interp_azi_data, interp_x_data, interp_y_data;
  std::unique_ptr<LinearInterpolation> linterp_x, linterp_y;
  // Mark the to-be-deleted elements
  for (const auto i : make_range(input_ext_node_num))
  {
    // For a zig-zag external boundary, when we add a conformal layer onto it by translating the
    // nodes in the surface normal direction, it is possible that the azimuthal order is flipped.
    // As shown below, o's are the original boundary nodes, and *'s are the nodes after
    // translation by the boundary layer thickness.
    //                         *  *
    // |               |       | /
    // o               o-------/--*
    // |               |     / |
    // | outside  -->  |   /   |
    // |               | /     |
    // o--------o--    o-------o--
    // To mitigate this flipping issue, we check the node flipping here using the cross product of
    // neighboring node-to-origin vectors. Flipped nodes are marked and excluded during the
    // follow-up interpolation.
    if (!MooseUtils::absoluteFuzzyEqual(input_bdry_angles[i], M_PI / 2.0, 1.0e-4))
    {
      unsigned int index_shift = 1;
      bool minus_shift_flag = true;
      bool plus_shift_flag = true;
      // Need to check both directions for multiple shifts
      // Half of the external boundary nodes are used as an upper limit to avert infinite loops
      while (index_shift < input_ext_node_num / 2 && (minus_shift_flag || plus_shift_flag))
      {
        if (((ref_inner_bdry_surf[MathUtils::euclideanMod(((int)i - (int)index_shift),
                                                          (int)input_ext_node_num)] -
              origin_pt)
                 .cross(ref_inner_bdry_surf[i] - origin_pt))(2) <= 0.0 &&
            minus_shift_flag)
          delete_mark[MathUtils::euclideanMod(((int)i - (int)index_shift),
                                              (int)input_ext_node_num)] = true;
        else
          minus_shift_flag = false;
        if (((ref_inner_bdry_surf[(i + index_shift) % input_ext_node_num] - origin_pt)
                 .cross(ref_inner_bdry_surf[i] - origin_pt))(2) >= 0.0 &&
            plus_shift_flag)
          delete_mark[(i + index_shift) % input_ext_node_num] = true;
        else
          plus_shift_flag = false;
        index_shift++;
      }
    }
  }
  // Create vectors for interpolation
  // Due to the flip issue, linear interpolation is used here to mark the location of the boundary
  // layer's outer boundary.
  for (const auto i : make_range(input_ext_node_num))
  {
    if (!delete_mark[i])
    {
      interp_azi_data.push_back(atan2(ref_inner_bdry_surf[i](1) - origin_pt(1),
                                      ref_inner_bdry_surf[i](0) - origin_pt(0)));
      interp_x_data.push_back(ref_inner_bdry_surf[i](0));
      interp_y_data.push_back(ref_inner_bdry_surf[i](1));
      if (interp_azi_data.size() > 1)
        if (interp_azi_data.back() < interp_azi_data[interp_azi_data.size() - 2])
          interp_azi_data.back() += 2.0 * M_PI;
    }
  }
  const Real interp_x0 = interp_x_data.front();
  const Real interp_xt = interp_x_data.back();
  const Real interp_y0 = interp_y_data.front();
  const Real interp_yt = interp_y_data.back();
  const Real incept_azi0 = interp_azi_data.front();
  const Real incept_azit = interp_azi_data.back();
 
  if (MooseUtils::absoluteFuzzyGreaterThan(incept_azi0, -M_PI))
  {
    interp_azi_data.insert(interp_azi_data.begin(), incept_azit - 2.0 * M_PI);
    interp_x_data.insert(interp_x_data.begin(), interp_xt);
    interp_y_data.insert(interp_y_data.begin(), interp_yt);
  }
  else
    interp_azi_data.front() = -M_PI;
  if (MooseUtils::absoluteFuzzyLessThan(incept_azit, M_PI))
  {
    interp_azi_data.push_back(incept_azi0 + 2 * M_PI);
    interp_x_data.push_back(interp_x0);
    interp_y_data.push_back(interp_y0);
  }
  else
    interp_azi_data.back() = M_PI;
 
  // Establish interpolation
  linterp_x = std::make_unique<LinearInterpolation>(interp_azi_data, interp_x_data);
  linterp_y = std::make_unique<LinearInterpolation>(interp_azi_data, interp_y_data);
  //  Loop to handle inner boundary layer
  for (const auto i : make_range(input_ext_node_num))
  {
    // Outside point of the inner boundary layer
    // Using interpolation, the azimuthal angles do not need to be changed.
    const Point inner_boundary_shift = Point(linterp_x->sample(azi_array[i] / 180.0 * M_PI),
                                             linterp_y->sample(azi_array[i] / 180.0 * M_PI),
                                             origin_pt(2)) -
                                       points_array[0][i];
    for (const auto j : make_range(uint(1), _peripheral_inner_boundary_layer_params.intervals + 1))
      points_array[j][i] =
          points_array[0][i] + inner_boundary_shift * inner_peripheral_bias_terms[j - 1];
  }
}

Referenced by generate().

◆ modifiedMultiBdryLayerParamsCreator()

PolygonMeshGeneratorBase::multiBdryLayerParams PolygonMeshGeneratorBase::modifiedMultiBdryLayerParamsCreator	(	const multiBdryLayerParams &	original_multi_bdry_layer_params,
		const unsigned int	order
	)		const

protectedinherited

Modifies the input multi boundary layer parameters for node generation, especially for the quadratic elements.

Parameters

original_multi_bdry_layer_params	original multi boundary layer parameters
order	order of the elements

Returns: modified multi boundary layer parameters

Definition at line 1773 of file PolygonMeshGeneratorBase.C.

{
  multiBdryLayerParams mod_multi_bdry_layer_params(original_multi_bdry_layer_params);
  std::for_each(mod_multi_bdry_layer_params.intervals.begin(),
                mod_multi_bdry_layer_params.intervals.end(),
                [&order](unsigned int & n) { n *= order; });
  std::for_each(mod_multi_bdry_layer_params.biases.begin(),
                mod_multi_bdry_layer_params.biases.end(),
                [&order](Real & n) { n = std::pow(n, 1.0 / order); });
  return mod_multi_bdry_layer_params;
}

Referenced by PolygonMeshGeneratorBase::buildSlice().

◆ modifiedSingleBdryLayerParamsCreator()

PolygonMeshGeneratorBase::singleBdryLayerParams PolygonMeshGeneratorBase::modifiedSingleBdryLayerParamsCreator	(	const singleBdryLayerParams &	original_single_bdry_layer_params,
		const unsigned int	order
	)		const

protectedinherited

Modifies the input single boundary layer parameters for node generation, especially for the quadratic elements.

Parameters

original_single_bdry_layer_params	original single boundary layer parameters
order	order of the elements

Returns: modified single boundary layer parameters

Definition at line 1787 of file PolygonMeshGeneratorBase.C.

{
  singleBdryLayerParams mod_single_bdry_layer_params(original_single_bdry_layer_params);
  mod_single_bdry_layer_params.intervals *= order;
  mod_single_bdry_layer_params.bias = std::pow(mod_single_bdry_layer_params.bias, 1.0 / order);
  return mod_single_bdry_layer_params;
}

Referenced by PolygonMeshGeneratorBase::buildSlice().

◆ nodeCoordRotate()

void PolygonMeshGeneratorBase::nodeCoordRotate	(	Real &	x,
		Real &	y,
		const Real	theta
	)		const

protectedinherited

Calculates x and y coordinates after rotating by theta angle.

Parameters

x	x coordinate of the node to be rotated
y	y coordinate of the node to be rotated
theta	rotation angle

Returns: n/a

Definition at line 1318 of file PolygonMeshGeneratorBase.C.

{
  const Real x_tmp = x;
  const Real y_tmp = y;
  x = x_tmp * std::cos(theta * M_PI / 180.0) - y_tmp * std::sin(theta * M_PI / 180.0);
  y = x_tmp * std::sin(theta * M_PI / 180.0) + y_tmp * std::cos(theta * M_PI / 180.0);
}

Referenced by PolygonMeshGeneratorBase::cutOffPolyDeform(), FlexiblePatternGenerator::FlexiblePatternGenerator(), PatternedCartesianMeshGenerator::generate(), PatternedHexMeshGenerator::generate(), and PolygonConcentricCircleMeshGeneratorBase::generate().

◆ pitchMetaDataErrorGenerator()

std::string PolygonMeshGeneratorBase::pitchMetaDataErrorGenerator	(	const std::vector< MeshGeneratorName > &	input_names,
		const std::vector< Real > &	metadata_vals,
		const std::string &	metadata_name
	)		const

protectedinherited

Generate a string that contains the detailed metadata information for inconsistent input mesh metadata error messages.

Parameters

input_names	list of input mesh generator names
metadata_vals	list of input mesh metadata values
metadata_name	name of the input mesh metadata

Returns: a string that contains the detailed metadata information

Definition at line 1797 of file PolygonMeshGeneratorBase.C.

{
  FormattedTable table;
  for (unsigned int i = 0; i < input_names.size(); i++)
  {
    table.addRow(i);
    table.addData<std::string>("input name", (std::string)input_names[i]);
    table.addData<Real>(metadata_name, metadata_vals[i]);
  }
  table.outputTimeColumn(false);
  std::stringstream detailed_error;
  table.printTable(detailed_error);
  return "\n" + detailed_error.str();
}

Referenced by PatternedCartesianMeshGenerator::generate(), and PatternedHexMeshGenerator::generate().

◆ pointInterpolate()

std::pair< Real, Real > PolygonMeshGeneratorBase::pointInterpolate	(	const Real	pi_1_x,
		const Real	pi_1_y,
		const Real	po_1_x,
		const Real	po_1_y,
		const Real	pi_2_x,
		const Real	pi_2_y,
		const Real	po_2_x,
		const Real	po_2_y,
		const unsigned int	i,
		const unsigned int	j,
		const unsigned int	num_sectors_per_side,
		const unsigned int	peripheral_intervals
	)		const

protectedinherited

Calculates the point coordinates of within a parallelogram region using linear interpolation.

Parameters

pi_1_x	x coordinate of the first inner side point (parallelogram vertex)
pi_1_y	y coordinate of the first inner side point (parallelogram vertex)
po_1_x	x coordinate of the first outer side point (parallelogram vertex)
po_1_y	y coordinate of the first outer side point (parallelogram vertex)
pi_2_x	x coordinate of the second inner side point (parallelogram vertex)
pi_2_y	y coordinate of the second inner side point (parallelogram vertex)
po_2_x	x coordinate of the second outer side point (parallelogram vertex)
po_2_y	y coordinate of the second outer side point (parallelogram vertex)
i	passed loop index 1
j	passed loop index 2
num_sectors_per_side	number of azimuthal intervals
peripheral_invervals	number of radial intervals of the peripheral region

Returns: an interpolated position within a parallelogram

Definition at line 1291 of file PolygonMeshGeneratorBase.C.

{
  auto position_px_inner =
      (pi_1_x * (num_sectors_per_side / 2.0 - j) + pi_2_x * j) / (num_sectors_per_side / 2.0);
  auto position_py_inner =
      (pi_1_y * (num_sectors_per_side / 2.0 - j) + pi_2_y * j) / (num_sectors_per_side / 2.0);
  auto position_px_outer =
      (d_po_1_x * (num_sectors_per_side / 2.0 - j) + d_po_2_x * j) / (num_sectors_per_side / 2.0);
  auto position_py_outer =
      (d_po_1_y * (num_sectors_per_side / 2.0 - j) + d_po_2_y * j) / (num_sectors_per_side / 2.0);
  auto position_px = position_px_inner + position_px_outer * i / peripheral_intervals;
  auto position_py = position_py_inner + position_py_outer * i / peripheral_intervals;
  return std::make_pair(position_px, position_py);
}

Referenced by PolygonMeshGeneratorBase::buildSimplePeripheral().

◆ quadElemDef()

void PolygonMeshGeneratorBase::quadElemDef	(	ReplicatedMesh &	mesh,
		const unsigned int	num_sectors_per_side,
		const std::vector< unsigned int >	subdomain_rings,
		const unsigned int	side_index,
		const std::vector< Real >	azimuthal_tangent = `std::vector<Real>()`,
		const subdomain_id_type	block_id_shift = `0`,
		const dof_id_type	nodeid_shift = `0`,
		const bool	create_inward_interface_boundaries = `false`,
		const bool	create_outward_interface_boundaries = `true`,
		const boundary_id_type	boundary_id_shift = `0`,
		const bool	generate_side_specific_boundaries = `true`,
		const QUAD_ELEM_TYPE	quad_elem_type = `QUAD_ELEM_TYPE::QUAD4`
	)		const

protectedinherited

Defines general quad elements for the polygon.

Parameters

mesh	input mesh to create the elements onto
num_sectors_per_side	number of azimuthal intervals
subdomain_rings	numbers of radial intervals of all involved subdomain layers
side_index	index of the polygon side
azimuthal_tangent	vector of tangent values of the azimuthal angles as reference for adaptive boundary matching
block_id_shift	shift of the subdomain ids generated by this function
nodeid_shift	shift of the node_ids of these elements
create_inward_interface_boundaries	whether inward interface boundary sidesets are created
create_outward_interface_boundaries	whether outward interface boundary sidesets are created
boundary_id_shift	shift of the interface boundary ids
generate_side_specific_boundaries	whether the side-specific external boundaries are generated or not
quad_elem_type	type of the quadrilateral elements to be generated

Definition at line 1051 of file PolygonMeshGeneratorBase.C.

{
  const unsigned short order = quad_elem_type == QUAD_ELEM_TYPE::QUAD4 ? 1 : 2;
  unsigned int angle_number = azimuthal_tangent.size() == 0
                                  ? num_sectors_per_side
                                  : ((azimuthal_tangent.size() - 1) / order);
 
  BoundaryInfo & boundary_info = mesh.get_boundary_info();
  unsigned int j = 0;
  for (unsigned int k = 0; k < (subdomain_rings.size()); k++)
  {
    for (unsigned int m = 0; m < subdomain_rings[k]; m++)
    {
      for (unsigned int i = 1; i <= angle_number; i++)
      {
        std::unique_ptr<Elem> new_elem;
        if (quad_elem_type == QUAD_ELEM_TYPE::QUAD4)
        {
          new_elem = std::make_unique<Quad4>();
          new_elem->set_node(0, mesh.node_ptr(nodeid_shift + i + (angle_number + 1) * j));
          new_elem->set_node(1, mesh.node_ptr(nodeid_shift + i + 1 + (angle_number + 1) * j));
          new_elem->set_node(2, mesh.node_ptr(nodeid_shift + i + (angle_number + 1) * (j + 1) + 1));
          new_elem->set_node(3, mesh.node_ptr(nodeid_shift + i + (angle_number + 1) * (j + 1)));
        }
        else // QUAD8/QUAD9
        {
          new_elem = std::make_unique<Quad8>();
          if (quad_elem_type == QUAD_ELEM_TYPE::QUAD9)
          {
            new_elem = std::make_unique<Quad9>();
            new_elem->set_node(
                8, mesh.node_ptr(nodeid_shift + i * 2 + (angle_number * 2 + 1) * (j * 2 + 2)));
          }
          new_elem->set_node(
              0,
              mesh.node_ptr(nodeid_shift + (i - 1) * 2 + 1 + (angle_number * 2 + 1) * (j * 2 + 1)));
          new_elem->set_node(
              1, mesh.node_ptr(nodeid_shift + i * 2 + 1 + (angle_number * 2 + 1) * (j * 2 + 1)));
          new_elem->set_node(
              2, mesh.node_ptr(nodeid_shift + i * 2 + 1 + (angle_number * 2 + 1) * (j * 2 + 3)));
          new_elem->set_node(
              3,
              mesh.node_ptr(nodeid_shift + (i - 1) * 2 + 1 + (angle_number * 2 + 1) * (j * 2 + 3)));
          new_elem->set_node(
              4, mesh.node_ptr(nodeid_shift + i * 2 + (angle_number * 2 + 1) * (j * 2 + 1)));
          new_elem->set_node(
              5, mesh.node_ptr(nodeid_shift + i * 2 + 1 + (angle_number * 2 + 1) * (j * 2 + 2)));
          new_elem->set_node(
              6, mesh.node_ptr(nodeid_shift + i * 2 + (angle_number * 2 + 1) * (j * 2 + 3)));
          new_elem->set_node(
              7,
              mesh.node_ptr(nodeid_shift + (i - 1) * 2 + 1 + (angle_number * 2 + 1) * (j * 2 + 2)));
        }
        Elem * elem = mesh.add_elem(std::move(new_elem));
        if (i == 1)
          boundary_info.add_side(elem, 3, SLICE_BEGIN);
        if (i == angle_number)
          boundary_info.add_side(elem, 1, SLICE_END);
 
        if (subdomain_rings[0] == 0)
          elem->subdomain_id() = k + 1 + block_id_shift;
        else
          elem->subdomain_id() = k + 2 + block_id_shift;
 
        if (m == 0 && create_inward_interface_boundaries && k > 0)
          boundary_info.add_side(elem, 0, k * 2 + boundary_id_shift);
        if (m == (subdomain_rings[k] - 1))
        {
          if (k == (subdomain_rings.size() - 1))
          {
            boundary_info.add_side(elem, 2, OUTER_SIDESET_ID);
            if (generate_side_specific_boundaries)
            {
              if (i <= angle_number / 2)
                boundary_info.add_side(elem, 2, OUTER_SIDESET_ID + side_index);
              else
                boundary_info.add_side(elem, 2, OUTER_SIDESET_ID_ALT + side_index);
            }
          }
          else if (create_outward_interface_boundaries)
            boundary_info.add_side(elem, 2, k * 2 + 1 + boundary_id_shift);
        }
      }
      j++;
    }
  }
}

Referenced by PolygonMeshGeneratorBase::buildSlice().

◆ reassignBoundaryIDs()

void PolygonMeshGeneratorBase::reassignBoundaryIDs	(	MeshBase &	mesh,
		const boundary_id_type	id_shift,
		const std::set< boundary_id_type > &	boundary_ids,
		const bool	reverse = `false`
	)

protectedinherited

reassign interface boundary IDs on the input mesh by applying the boundary ID shift

Parameters

mesh	input mesh
id_shift	ID shift value to be applied
boundary_ids	list of boundary IDs to be reassigned
reverse	remove boundary ID shift

Definition at line 1701 of file PolygonMeshGeneratorBase.C.

{
  const std::set<boundary_id_type> existing_boundary_ids =
      mesh.get_boundary_info().get_boundary_ids();
  for (const auto id : boundary_ids)
  {
 
    const boundary_id_type old_id = (!reverse) ? id : id + id_shift;
    const boundary_id_type new_id = (!reverse) ? id + id_shift : id;
    auto it = existing_boundary_ids.find(old_id);
    if (it != existing_boundary_ids.end())
      MooseMesh::changeBoundaryId(mesh, old_id, new_id, true);
  }
}

Referenced by PatternedCartesianMeshGenerator::generate(), and PatternedHexMeshGenerator::generate().

◆ ringNodes()

void PolygonMeshGeneratorBase::ringNodes	(	ReplicatedMesh &	mesh,
		const std::vector< Real >	ring_radii,
		const std::vector< unsigned int >	ring_layers,
		const std::vector< std::vector< Real > >	biased_terms,
		const unsigned int	num_sectors_per_side,
		const Real	corner_p[2][2],
		const Real	corner_to_corner,
		const std::vector< Real >	azimuthal_tangent = `std::vector<Real>()`
	)		const

protectedinherited

Creates nodes for the ring-geometry region of a single slice.

Parameters

mesh	input mesh to add the nodes onto
ring_radii	radii of the ring regions
ring_layers	numbers of radial intervals of the ring regions
biased_terms	normalized spacing values used for radial meshing biasing in ring regions
num_sectors_per_side	number of azimuthal intervals
corner_p[2][2]	array contains the coordinates of the corner positions
corner_to_corner	diameter of the circumscribed circle of the polygon
azimuthal_tangent	vector of tangent values of the azimuthal angles as reference for adaptive boundary matching

Definition at line 654 of file PolygonMeshGeneratorBase.C.

{
  const unsigned int angle_number =
      azimuthal_tangent.size() == 0 ? num_sectors_per_side : (azimuthal_tangent.size() - 1);
 
  // Add nodes in pins regions
  for (unsigned int l = 0; l < ring_layers.size(); l++)
  {
    // the pin radius interval for each ring_radii/subdomain
    const Real pin_radius_interval_length =
        l == 0 ? ring_radii[l] / ring_layers[l]
               : (ring_radii[l] - ring_radii[l - 1]) / ring_layers[l];
 
    // add rings in each pin subdomain
    for (unsigned int k = 0; k < ring_layers[l]; k++)
    {
      const Real bin_radial_distance =
          l == 0 ? (biased_terms[l][k] * ring_layers[l] *
                    pin_radius_interval_length) // this is from the cell/pin center to
                                                // the first circle
                 : (ring_radii[l - 1] +
                    biased_terms[l][k] * ring_layers[l] * pin_radius_interval_length);
      const Real pin_corner_p_x = corner_p[0][0] * bin_radial_distance / (0.5 * corner_to_corner);
      const Real pin_corner_p_y = corner_p[0][1] * bin_radial_distance / (0.5 * corner_to_corner);
 
      // pin_corner_p(s) are the points in the pin region, on the bins towards the six corners,
      // at different intervals
      mesh.add_point(Point(pin_corner_p_x, pin_corner_p_y, 0.0));
 
      for (unsigned int j = 1; j <= angle_number; j++)
      {
        const Real cell_boundary_p_x =
            corner_p[0][0] + (corner_p[1][0] - corner_p[0][0]) *
                                 (azimuthal_tangent.size() == 0 ? ((Real)j / (Real)angle_number)
                                                                : (azimuthal_tangent[j] / 2.0));
        const Real cell_boundary_p_y =
            corner_p[0][1] + (corner_p[1][1] - corner_p[0][1]) *
                                 (azimuthal_tangent.size() == 0 ? ((Real)j / (Real)angle_number)
                                                                : (azimuthal_tangent[j] / 2.0));
        // cell_boundary_p(s) are the points on the cell's six boundaries (flat sides) at
        // different azimuthal angles
        const Real pin_azimuthal_p_x =
            cell_boundary_p_x * bin_radial_distance /
            std::sqrt(Utility::pow<2>(cell_boundary_p_x) + Utility::pow<2>(cell_boundary_p_y));
        const Real pin_azimuthal_p_y =
            cell_boundary_p_y * bin_radial_distance /
            std::sqrt(Utility::pow<2>(cell_boundary_p_x) + Utility::pow<2>(cell_boundary_p_y));
 
        // pin_azimuthal_p are the points on the bins towards different azimuthal angles, at
        // different intervals; excluding the ones produced by pin_corner_p
        mesh.add_point(Point(pin_azimuthal_p_x, pin_azimuthal_p_y, 0.0));
      }
    }
  }
}

Referenced by PolygonMeshGeneratorBase::buildSlice().

◆ setRingExtraIDs()

void PolygonMeshGeneratorBase::setRingExtraIDs	(	MeshBase &	mesh,
		const std::string	id_name,
		const unsigned int	num_sides,
		const std::vector< unsigned int >	num_sectors_per_side,
		const std::vector< unsigned int >	ring_intervals,
		const bool	ring_wise_id,
		const bool	quad_center_elements
	)

protectedinherited

assign ring extra ids to polygon mesh

Parameters

mesh	input mesh where ring extra ids are assigned
id_name	ring extra id name
num_sides	number of polygon sides
num_sectors_per_side	number of sectors of each side of the polygon
ring_intervals	number of rings in each circle
ring_wise_id	whether ring ids are assigned to each ring or to each block
quad_center_elements	whether center elements are quad or triangular

Definition at line 1636 of file PolygonMeshGeneratorBase.C.

{
  // this function assumes that elements are ordered by rings (inner) then by sectors (outer
  // ordering)
  const auto extra_id_index = mesh.add_elem_integer(id_name);
  auto elem_it = mesh.elements_begin();
  for (unsigned int is = 0; is < num_sides; ++is)
  {
    // number of elements in the current sector
    unsigned int nelem = mesh.n_elem() * num_sectors_per_side[is] /
                         (accumulate(num_sectors_per_side.begin(), num_sectors_per_side.end(), 0));
    if (!ring_wise_id)
    {
      for (unsigned int ir : index_range(ring_intervals))
      {
        // number of elements in the current ring and sector
        unsigned int nelem_annular_ring = num_sectors_per_side[is] * ring_intervals[ir];
        // if _quad_center_elements is true, the number of elements in center ring are
        // _num_sectors_per_side[is] * _num_sectors_per_side[is] / 4
        if (quad_center_elements && ir == 0)
          nelem_annular_ring = num_sectors_per_side[is] * (ring_intervals[ir] - 1) +
                               num_sectors_per_side[is] * num_sectors_per_side[is] / 4;
        // assign ring id
        for (unsigned i = 0; i < nelem_annular_ring; ++i, ++elem_it)
          (*elem_it)->set_extra_integer(extra_id_index, ir + 1);
        // update number of elements in background region of current side.
        nelem -= nelem_annular_ring;
      }
    }
    else
    {
      unsigned int ir = 0;
      for (unsigned int ir0 : index_range(ring_intervals))
      {
        for (unsigned int ir1 = 0; ir1 < ring_intervals[ir0]; ++ir1)
        {
          // number of elements in the current ring and sector
          unsigned int nelem_annular_ring = num_sectors_per_side[is];
          // if _quad_center_elements is true, the number of elements in center ring are
          // _num_sectors_per_side[is] * _num_sectors_per_side[is] / 4
          if (quad_center_elements && ir == 0)
            nelem_annular_ring = num_sectors_per_side[is] * num_sectors_per_side[is] / 4;
          // assign ring id
          for (unsigned i = 0; i < nelem_annular_ring; ++i, ++elem_it)
            (*elem_it)->set_extra_integer(extra_id_index, ir + 1);
          // update ring id
          ++ir;
          // update number of elements in background region of current side.
          nelem -= nelem_annular_ring;
        }
      }
    }
    // assign ring id of 0 to the background region
    for (unsigned i = 0; i < nelem; ++i, ++elem_it)
      (*elem_it)->set_extra_integer(extra_id_index, 0);
  }
}

Referenced by PolygonConcentricCircleMeshGeneratorBase::generate(), and TriPinHexAssemblyGenerator::generate().

◆ setSectorExtraIDs()

void PolygonMeshGeneratorBase::setSectorExtraIDs	(	MeshBase &	mesh,
		const std::string	id_name,
		const unsigned int	num_sides,
		const std::vector< unsigned int >	num_sectors_per_side
	)

protectedinherited

assign sector extra ids to polygon mesh

Parameters

mesh	input mesh where sector extra ids are assigned
id_name	sector extra ID name
num_side	number of polygon sides
num_sectors_per_side	number of sections of each side of the polygon

Definition at line 1611 of file PolygonMeshGeneratorBase.C.

{
  const auto extra_id_index = mesh.add_elem_integer(id_name);
  // vector to store sector ids for each element
  auto elem_it = mesh.elements_begin();
  unsigned int id = 1;
  // starting element id of the current sector
  for (unsigned int is = 0; is < num_sides; ++is)
  {
    // number of elements in the current sector
    unsigned int nelem_sector =
        mesh.n_elem() * num_sectors_per_side[is] /
        (accumulate(num_sectors_per_side.begin(), num_sectors_per_side.end(), 0));
    // assign sector ids to mesh
    for (unsigned i = 0; i < nelem_sector; ++i, ++elem_it)
      (*elem_it)->set_extra_integer(extra_id_index, id);
    // update sector id
    ++id;
  }
}

Referenced by PolygonConcentricCircleMeshGeneratorBase::generate(), and TriPinHexAssemblyGenerator::generate().

◆ validParams()

InputParameters PeripheralRingMeshGenerator::validParams ( )

static

Definition at line 25 of file PeripheralRingMeshGenerator.C.

{
  InputParameters params = PolygonMeshGeneratorBase::validParams();
  params.addRequiredParam<MeshGeneratorName>("input", "The input mesh to be modified.");
  params.addParam<bool>(
      "force_input_centroid_as_center",
      false,
      "Whether to enforce use of the centroid position of the input mesh as the "
      "center of the peripheral ring by translating the input mesh to the origin.");
 
  params.addRangeCheckedParam<unsigned int>(
      "peripheral_layer_num",
      3,
      "peripheral_layer_num>0",
      "The radial layers of the peripheral ring to be added.");
  params.addRangeCheckedParam<Real>(
      "peripheral_radial_bias",
      1.0,
      "peripheral_radial_bias>0",
      "Value used to create biasing in radial meshing for peripheral ring region.");
  params.addRangeCheckedParam<Real>(
      "peripheral_inner_boundary_layer_width",
      0.0,
      "peripheral_inner_boundary_layer_width>=0",
      "Width of peripheral ring region that is assigned to be the inner boundary layer.");
  params.addRangeCheckedParam<unsigned int>(
      "peripheral_inner_boundary_layer_intervals",
      1,
      "peripheral_inner_boundary_layer_intervals>0",
      "Number of radial intervals of the peripheral ring inner boundary layer");
  params.addRangeCheckedParam<Real>(
      "peripheral_inner_boundary_layer_bias",
      1.0,
      "peripheral_inner_boundary_layer_bias>0",
      "Growth factor used for mesh biasing of the peripheral ring inner boundary layer.");
  params.addRangeCheckedParam<Real>(
      "peripheral_outer_boundary_layer_width",
      0.0,
      "peripheral_outer_boundary_layer_width>=0",
      "Width of peripheral ring region that is assigned to be the outer boundary layer.");
  params.addRangeCheckedParam<unsigned int>(
      "peripheral_outer_boundary_layer_intervals",
      1,
      "peripheral_outer_boundary_layer_intervals>0",
      "Number of radial intervals of the peripheral ring outer boundary layer");
  params.addRangeCheckedParam<Real>(
      "peripheral_outer_boundary_layer_bias",
      1.0,
      "peripheral_outer_boundary_layer_bias>0",
      "Growth factor used for mesh biasing of the peripheral ring outer boundary layer.");
  params.addRequiredRangeCheckedParam<Real>("peripheral_ring_radius",
                                            "peripheral_ring_radius>0",
                                            "Radius of the peripheral ring to be added.");
  params.addParam<bool>(
      "preserve_volumes",
      true,
      "Whether the volume of the peripheral region is preserved by fixing the radius.");
  params.addRequiredParam<BoundaryName>("input_mesh_external_boundary",
                                        "The external boundary of the input mesh.");
  params.addRequiredParam<subdomain_id_type>(
      "peripheral_ring_block_id", "The block id assigned to the created peripheral layer.");
  params.addParam<SubdomainName>("peripheral_ring_block_name",
                                 "The block name assigned to the created peripheral layer.");
  params.addRangeCheckedParam<boundary_id_type>("external_boundary_id",
                                                "external_boundary_id>0",
                                                "Optional customized external boundary id.");
  params.addParam<BoundaryName>(
      "external_boundary_name", "", "Optional customized external boundary name.");
  params.addParamNamesToGroup(
      "peripheral_radial_bias peripheral_inner_boundary_layer_width "
      "peripheral_inner_boundary_layer_intervals peripheral_inner_boundary_layer_bias "
      "peripheral_outer_boundary_layer_width peripheral_outer_boundary_layer_intervals "
      "peripheral_outer_boundary_layer_bias",
      "Mesh Boundary Layer and Biasing Options");
  params.addClassDescription("This PeripheralRingMeshGenerator object adds a circular peripheral "
                             "region to the input mesh.");
 
  return params;
}

Referenced by generate().

◆ _preserve_volumes

const bool PeripheralRingMeshGenerator::_preserve_volumes

protected

Volume preserving function is optional.

Definition at line 45 of file PeripheralRingMeshGenerator.h.

Referenced by generate().

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

reactor/include/meshgenerators/PeripheralRingMeshGenerator.h
reactor/src/meshgenerators/PeripheralRingMeshGenerator.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ INTRINSIC_NUM_SIDES

◆ INTRINSIC_SIDESET_ID

◆ INTRISIC_SUBDOMAIN_ID

◆ MESH_TYPE

◆ PolygonSizeStyle

◆ QUAD_ELEM_TYPE

◆ RETURN_TYPE

◆ TRI_ELEM_TYPE

Constructor & Destructor Documentation

◆ PeripheralRingMeshGenerator()

Member Function Documentation

◆ addRingAndSectorIDParams()

◆ adjustPeripheralQuadraticElements()

◆ azimuthalAnglesCollector() [1/2]

◆ azimuthalAnglesCollector() [2/2]

◆ backgroundNodes()

◆ biasTermsCalculator() [1/2]

◆ biasTermsCalculator() [2/2]

◆ buildGeneralSlice()

◆ buildSimplePeripheral()

◆ buildSimpleSlice()

◆ buildSlice()

◆ cenQuadElemDef()

◆ centerNodes()

◆ cenTriElemDef()

◆ cutOffPolyDeform()

◆ ductNodes()

◆ fourPointIntercept()

◆ generate()

◆ getInterfaceBoundaryIDs()

◆ innerBdryLayerNodesDefiner()

◆ modifiedMultiBdryLayerParamsCreator()

◆ modifiedSingleBdryLayerParamsCreator()

◆ nodeCoordRotate()

◆ pitchMetaDataErrorGenerator()

◆ pointInterpolate()

◆ quadElemDef()

◆ reassignBoundaryIDs()

◆ ringNodes()

◆ setRingExtraIDs()

◆ setSectorExtraIDs()

◆ validParams()

Member Data Documentation

◆ _external_boundary_id

◆ _external_boundary_name

◆ _force_input_centroid_as_center

◆ _input

◆ _input_mesh_external_bid

◆ _input_mesh_external_boundary

◆ _input_name

◆ _peripheral_inner_boundary_layer_params

◆ _peripheral_layer_num

◆ _peripheral_outer_boundary_layer_params

◆ _peripheral_radial_bias

◆ _peripheral_ring_block_id

◆ _peripheral_ring_block_name

◆ _peripheral_ring_radius

◆ _preserve_volumes