SubChannelMesh.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include <vector>
#include <utility> // std::pair
#include <map>

#include "MooseMesh.h"
#include "SubChannelEnums.h"

class SubChannelMesh : public MooseMesh
{
public:
  SubChannelMesh(const InputParameters & parameters);
  SubChannelMesh(const SubChannelMesh & other_mesh);

  virtual const std::vector<Real> & getZGrid() const { return _z_grid; }

  virtual unsigned int getZIndex(const Point & point) const;

  virtual const std::vector<std::vector<Real>> & getKGrid() const { return _k_grid; }

  virtual const std::vector<Real> & getZBlockage() const { return _z_blockage; }

  virtual const std::vector<unsigned int> & getIndexBlockage() const { return _index_blockage; }

  virtual const std::vector<Real> & getReductionBlockage() const { return _reduction_blockage; }

  virtual const Real & getKij() const { return _kij; }

  virtual unsigned int getNumOfAxialCells() const { return processor_id() == 0 ? _n_cells : 0; }

  virtual Node * getChannelNode(unsigned int i_chan, unsigned int iz) const = 0;

  virtual Node * getPinNode(unsigned int i_pin, unsigned int iz) const = 0;

  Node * getChannelNodeFromDuct(Node * duct_node) const;

  Node * getDuctNodeFromChannel(Node * channel_node) const;

  virtual unsigned int getNumOfChannels() const = 0;

  bool pinMeshExist() const { return _pin_mesh_exist; }

  bool ductMeshExist() const { return _duct_mesh_exist; }

  virtual unsigned int getNumOfGapsPerLayer() const = 0;

  virtual unsigned int getNumOfPins() const = 0;

  virtual const std::pair<unsigned int, unsigned int> &
  getGapChannels(unsigned int i_gap) const = 0;

  virtual const std::pair<unsigned int, unsigned int> & getGapPins(unsigned int i_gap) const = 0;

  virtual const std::vector<unsigned int> & getChannelGaps(unsigned int i_chan) const = 0;

  virtual const std::vector<unsigned int> & getPinChannels(unsigned int i_pin) const = 0;

  virtual const std::vector<unsigned int> & getChannelPins(unsigned int i_chan) const = 0;

  virtual const Real & getPitch() const { return _pitch; }

  virtual const Real & getPinDiameter() const { return _pin_diameter; }

  Real getAssemblyFlowArea() const { return _assembly_flow_area; }

  Real getAssemblyWettedPerimeter() const { return _assembly_wetted_perimeter; }

  Real getAssemblyHydraulicDiameter() const { return _assembly_hydraulic_diameter; }

  virtual Real getSubchannelFlowArea(unsigned int i_chan, Real z) const = 0;

  virtual Real getSubchannelWettedPerimeter(unsigned int i_chan) const = 0;

  virtual const Real & getCrossflowSign(unsigned int i_chan, unsigned int i_local) const = 0;

  virtual const Real & getHeatedLengthEntry() const { return _unheated_length_entry; }

  virtual const Real & getHeatedLength() const { return _heated_length; }

  virtual const Real & getHeatedLengthExit() const { return _unheated_length_exit; }

  virtual unsigned int getSubchannelIndexFromPoint(const Point & p) const = 0;

  virtual unsigned int channelIndex(const Point & point) const = 0;

  virtual unsigned int getPinIndexFromPoint(const Point & p) const = 0;

  virtual unsigned int pinIndex(const Point & p) const = 0;

  virtual EChannelType getSubchannelType(unsigned int index) const = 0;

  virtual Real getGapWidth(unsigned int axial_index, unsigned int gap_index) const = 0;

  const std::vector<Node *> & getDuctNodes() const { return _duct_nodes; }

  void setChannelToDuctMaps(const std::vector<Node *> & duct_nodes);

  bool _pin_mesh_exist = false;
  bool _duct_mesh_exist = false;

protected:
  Real _unheated_length_entry;
  Real _heated_length;
  Real _unheated_length_exit;

  std::vector<Real> _z_grid;
  std::vector<std::vector<Real>> _k_grid;

  std::vector<Node *> _duct_nodes;

  std::map<Node *, Node *> _chan_to_duct_node_map;
  std::map<Node *, Node *> _duct_node_to_chan_map;

  std::vector<Real> _spacer_z;
  std::vector<Real> _spacer_k;

  std::vector<Real> _z_blockage;
  std::vector<unsigned int> _index_blockage;
  std::vector<Real> _reduction_blockage;

  Real _kij;
  Real _pitch;
  Real _pin_diameter;
  Real _assembly_flow_area;
  Real _assembly_wetted_perimeter;
  Real _assembly_hydraulic_diameter;

  unsigned int _n_cells;

public:
  std::vector<std::vector<Real>> _subchannel_position;

  static InputParameters validParams();

  static void generateZGrid(Real unheated_length_entry,
                            Real heated_length,
                            Real unheated_length_exit,
                            unsigned int n_cells,
                            std::vector<Real> & z_grid);

  friend class SCMQuadAssemblyMeshGenerator;
};