Merge pull request #32289 from kyriv1980/quadDuct

Create square duct mesh #31406

Author: GiudGiud

modules/subchannel/doc/content/source/meshgenerators/SCMQuadDuctMeshGenerator.md

@@ -0,0 +1,17 @@
+# SCMQuadDuctMeshGenerator
+
+!syntax description /Mesh/SCMQuadDuctMeshGenerator
+
+## Overview
+
+!! Intentional comment to provide extra spacing
+
+This mesh generator creates the mesh (with Quad4 elements) where the variables associated with the duct live.
+
+The subdomain name used for the duct will match the name of this mesh generator.
+
+!syntax parameters /Mesh/SCMQuadDuctMeshGenerator
+
+!syntax inputs /Mesh/SCMQuadDuctMeshGenerator
+
+!syntax children /Mesh/SCMQuadDuctMeshGenerator

modules/subchannel/doc/content/source/meshgenerators/SCMTriDuctMeshGenerator.md

@@ -6,7 +6,9 @@
 
 !! Intentional comment to provide extra spacing
 
-This mesh generator creates the mesh were the variables associated with the duct live.
+This mesh generator creates the mesh (with Quad4 elements) where the variables associated with the duct live.
+
+The subdomain name used for the duct will match the name of this mesh generator.
 
 ## Example Input File Syntax
 

modules/subchannel/include/mesh/QuadSubChannelMesh.h

@@ -12,6 +12,11 @@
 #include "SubChannelMesh.h"
 #include "SubChannelEnums.h"
 
+#include <map>
+#include <vector>
+#include <memory>  // for unique_ptr
+#include <utility> // for std::pair
+
 /**
  * Creates the mesh of subchannels in a quadrilateral lattice.
  */
@@ -20,90 +25,70 @@ class QuadSubChannelMesh : public SubChannelMesh
 public:
   QuadSubChannelMesh(const InputParameters & parameters);
   QuadSubChannelMesh(const QuadSubChannelMesh & other_mesh);
-  virtual std::unique_ptr<MooseMesh> safeClone() const override;
-  virtual void buildMesh() override;
 
-  virtual Node * getChannelNode(unsigned int i_chan, unsigned iz) const override
+  std::unique_ptr<MooseMesh> safeClone() const override;
+  void buildMesh() override;
+
+  Node * getChannelNode(unsigned int i_chan, unsigned int iz) const override
   {
     return _nodes[i_chan][iz];
   }
 
-  virtual Node * getPinNode(unsigned int i_pin, unsigned iz) const override
+  Node * getPinNode(unsigned int i_pin, unsigned int iz) const override
   {
     return _pin_nodes[i_pin][iz];
   }
 
-  /**
-   * Duct functions not applicable to quad channel
-   *
-   * Over-writing to avoid abstract template definition in this class
-   */
-  ///@{
-  virtual Node * getDuctNodeFromChannel(Node *) override { return nullptr; }
-  virtual Node * getChannelNodeFromDuct(Node *) override { return nullptr; }
-  virtual const std::vector<Node *> getDuctNodes() const override { return std::vector<Node *>(); }
-  ///@}
+  unsigned int getNumOfChannels() const override { return processor_id() == 0 ? _n_channels : 0; }
+  unsigned int getNumOfGapsPerLayer() const override { return processor_id() == 0 ? _n_gaps : 0; }
+  unsigned int getNumOfPins() const override { return processor_id() == 0 ? _n_pins : 0; }
 
-  virtual unsigned int getNumOfChannels() const override
-  {
-    return processor_id() == 0 ? _n_channels : 0;
-  }
-  virtual unsigned int getNumOfGapsPerLayer() const override
-  {
-    return processor_id() == 0 ? _n_gaps : 0;
-  }
-  virtual unsigned int getNumOfPins() const override { return processor_id() == 0 ? _n_pins : 0; }
-  virtual bool pinMeshExist() const override { return _pin_mesh_exist; }
-  virtual bool ductMeshExist() const override { return false; }
-  virtual const std::pair<unsigned int, unsigned int> &
-  getGapChannels(unsigned int i_gap) const override
+  const std::pair<unsigned int, unsigned int> & getGapChannels(unsigned int i_gap) const override
   {
     return _gap_to_chan_map[i_gap];
   }
-  virtual const std::pair<unsigned int, unsigned int> &
-  getGapPins(unsigned int i_gap) const override
+  const std::pair<unsigned int, unsigned int> & getGapPins(unsigned int i_gap) const override
   {
     return _gap_to_pin_map[i_gap];
   }
-  virtual const std::vector<unsigned int> & getChannelGaps(unsigned int i_chan) const override
+  const std::vector<unsigned int> & getChannelGaps(unsigned int i_chan) const override
   {
     return _chan_to_gap_map[i_chan];
   }
-  virtual const std::vector<unsigned int> & getPinChannels(unsigned int i_pin) const override
+  const std::vector<unsigned int> & getPinChannels(unsigned int i_pin) const override
   {
     return _pin_to_chan_map[i_pin];
   }
-  virtual const std::vector<unsigned int> & getChannelPins(unsigned int i_chan) const override
+  const std::vector<unsigned int> & getChannelPins(unsigned int i_chan) const override
   {
     return _chan_to_pin_map[i_chan];
   }
-  virtual const Real & getPitch() const override { return _pitch; }
-  virtual const Real & getCrossflowSign(unsigned int i_chan, unsigned int i_local) const override
+  const Real & getPitch() const override { return _pitch; }
+  const Real & getCrossflowSign(unsigned int i_chan, unsigned int i_local) const override
   {
     return _sign_id_crossflow_map[i_chan][i_local];
   }
+
   /// Number of subchannels in the -x direction
-  virtual const unsigned int & getNx() const { return _nx; }
+  const unsigned int & getNx() const { return _nx; }
   /// Number of subchannels in the -y direction
-  virtual const unsigned int & getNy() const { return _ny; }
+  const unsigned int & getNy() const { return _ny; }
+
   /**
    * Returns the side gap, not to be confused with the gap between pins, this refers to the gap
    * next to the duct. Edge Pitch W = (pitch/2 - pin_diameter/2 + gap) [m]
    */
   const Real & getSideGap() const { return _side_gap; }
 
   unsigned int getSubchannelIndexFromPoint(const Point & p) const override;
-  virtual unsigned int channelIndex(const Point & point) const override;
+  unsigned int channelIndex(const Point & point) const override;
 
   unsigned int getPinIndexFromPoint(const Point & p) const override;
-  virtual unsigned int pinIndex(const Point & p) const override;
+  unsigned int pinIndex(const Point & p) const override;
 
-  virtual EChannelType getSubchannelType(unsigned int index) const override
-  {
-    return _subch_type[index];
-  }
+  EChannelType getSubchannelType(unsigned int index) const override { return _subch_type[index]; }
 
-  virtual Real getGapWidth(unsigned int axial_index, unsigned int gap_index) const override
+  Real getGapWidth(unsigned int axial_index, unsigned int gap_index) const override
   {
     return _gij_map[axial_index][gap_index];
   }
@@ -119,18 +104,21 @@ class QuadSubChannelMesh : public SubChannelMesh
   unsigned int _n_gaps;
   /// Number of pins
   unsigned int _n_pins;
+
   /**
    * The side gap, not to be confused with the gap between pins, this refers to the gap
    * next to the duct or else the distance between the subchannel centroid to the duct wall.
    * Edge Pitch W = (pitch/2 - pin_diameter/2 + gap) [m]
    */
   Real _side_gap;
+
   /// vector of subchannel nodes
   std::vector<std::vector<Node *>> _nodes;
   /// vector of fuel pin nodes
   std::vector<std::vector<Node *>> _pin_nodes;
   /// vector of gap (interface between pairs of neighboring subchannels) nodes
   std::vector<std::vector<Node *>> _gapnodes;
+
   /// map relating gap index to subchannel index
   std::vector<std::pair<unsigned int, unsigned int>> _gap_to_chan_map;
   /// map relating gap index to fuel pin index
@@ -141,14 +129,13 @@ class QuadSubChannelMesh : public SubChannelMesh
   std::vector<std::vector<unsigned int>> _chan_to_pin_map;
   /// map relating fuel pin index to subchannel index
   std::vector<std::vector<unsigned int>> _pin_to_chan_map;
+
   /// Matrix used to give local sign to crossflow quantities
   std::vector<std::vector<double>> _sign_id_crossflow_map;
   /// Vector to store gap size
   std::vector<std::vector<Real>> _gij_map;
   /// Subchannel type
   std::vector<EChannelType> _subch_type;
-  /// Flag that informs the solver whether there is a Pin Mesh or not
-  bool _pin_mesh_exist;
 
 public:
   static InputParameters validParams();

modules/subchannel/include/mesh/SubChannelMesh.h

@@ -10,6 +10,9 @@
 #pragma once
 
 #include <vector>
+#include <utility> // std::pair
+#include <map>
+
 #include "MooseMesh.h"
 #include "SubChannelEnums.h"
 
@@ -65,22 +68,22 @@ class SubChannelMesh : public MooseMesh
   /**
    * Get the subchannel mesh node for a given channel index and elevation index
    */
-  virtual Node * getChannelNode(unsigned int i_chan, unsigned iz) const = 0;
+  virtual Node * getChannelNode(unsigned int i_chan, unsigned int iz) const = 0;
 
   /**
    * Get the pin mesh node for a given pin index and elevation index
    */
-  virtual Node * getPinNode(unsigned int i_pin, unsigned iz) const = 0;
+  virtual Node * getPinNode(unsigned int i_pin, unsigned int iz) const = 0;
 
   /**
    * Function that gets the channel node from the duct node
    */
-  virtual Node * getChannelNodeFromDuct(Node * channel_node) = 0;
+  Node * getChannelNodeFromDuct(Node * duct_node) const;
 
   /**
    * Function that gets the duct node from the channel node
    */
-  virtual Node * getDuctNodeFromChannel(Node * channel_node) = 0;
+  Node * getDuctNodeFromChannel(Node * channel_node) const;
 
   /**
    * Return the number of channels per layer
@@ -90,12 +93,12 @@ class SubChannelMesh : public MooseMesh
   /**
    * Return if Pin Mesh exists or not
    */
-  virtual bool pinMeshExist() const = 0;
+  bool pinMeshExist() const { return _pin_mesh_exist; }
 
   /**
    * Return if Duct Mesh exists or not
    */
-  virtual bool ductMeshExist() const = 0;
+  bool ductMeshExist() const { return _duct_mesh_exist; }
 
   /**
    * Return the number of gaps per layer
@@ -188,9 +191,18 @@ class SubChannelMesh : public MooseMesh
   virtual Real getGapWidth(unsigned int axial_index, unsigned int gap_index) const = 0;
 
   /**
-   * Function that return the vector with the maps to the nodes if they exist
+   * Function that returns the vector with the duct nodes
+   *
+   */
+  const std::vector<Node *> & getDuctNodes() const { return _duct_nodes; }
+
+  /**
+   * Function that sets the channel-to-duct maps
    */
-  virtual const std::vector<Node *> getDuctNodes() const = 0;
+  void setChannelToDuctMaps(const std::vector<Node *> & duct_nodes);
+
+  bool _pin_mesh_exist = false;
+  bool _duct_mesh_exist = false;
 
 protected:
   /// unheated length of the fuel Pin at the entry of the assembly
@@ -199,32 +211,46 @@ class SubChannelMesh : public MooseMesh
   Real _heated_length;
   /// unheated length of the fuel Pin at the exit of the assembly
   Real _unheated_length_exit;
+
   /// axial location of nodes
   std::vector<Real> _z_grid;
   /// axial form loss coefficient per computational cell
   std::vector<std::vector<Real>> _k_grid;
+
+  /// A list of all mesh nodes that form the (elements of) the duct
+  /// mesh that surrounds the pins/subchannels.
+  std::vector<Node *> _duct_nodes;
+
+  /// Maps between channel nodes and duct nodes
+  std::map<Node *, Node *> _chan_to_duct_node_map;
+  std::map<Node *, Node *> _duct_node_to_chan_map;
+
   /// axial location of the spacers
   std::vector<Real> _spacer_z;
   /// form loss coefficient of the spacers
   std::vector<Real> _spacer_k;
+
   /// axial location of blockage (inlet, outlet) [m]
   std::vector<Real> _z_blockage;
   /// index of subchannels affected by blockage
   std::vector<unsigned int> _index_blockage;
   /// area reduction of subchannels affected by blockage
   std::vector<Real> _reduction_blockage;
+
   /// Lateral form loss coefficient
   Real _kij;
   /// Distance between the neighbor fuel pins, pitch
   Real _pitch;
   /// fuel Pin diameter
   Real _pin_diameter;
+
   /// number of axial cells
   unsigned int _n_cells;
 
 public:
   /// x,y coordinates of the subchannel centroids
   std::vector<std::vector<Real>> _subchannel_position;
+
   static InputParameters validParams();
 
   /**