https://mooseframework.inl.gov
SCMQuadPowerAux.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "SCMQuadPowerAux.h"
11 #include "Function.h"
12 #include "QuadSubChannelMesh.h"
13 #include "SCM.h"
14 
15 registerMooseObject("SubChannelApp", SCMQuadPowerAux);
16 registerMooseObjectRenamed("SubChannelApp", QuadPowerAux, "06/30/2025 24:00", SCMQuadPowerAux);
17 
20 {
22  params.addClassDescription(
23  "Computes axial power rate (W/m) that goes into the subchannel cells "
24  "or is assigned to the fuel pins, in a quadrilateral lattice arrangement");
25  params.addRequiredParam<PostprocessorName>(
26  "power", "The postprocessor or Real to use for the total power of the subassembly [W]");
27  params.addRequiredParam<std::string>(
28  "filename", "name of radial power profile .txt file (should be a single column) [UnitLess].");
29  params.addParam<FunctionName>("axial_heat_rate",
30  "1.0",
31  "user provided normalized function of axial heat rate [Unitless]. "
32  "The integral over pin length should equal the heated length");
33  return params;
34 }
35 
37  : AuxKernel(parameters),
38  _quadMesh(SCM::getConstMesh<QuadSubChannelMesh>(_mesh)),
39  _power(getPostprocessorValue("power")),
40  _numberoflines(0),
41  _filename(getParam<std::string>("filename")),
42  _axial_heat_rate(getFunction("axial_heat_rate"))
43 {
44  if (processor_id() > 0)
45  return;
46 
47  auto nx = _quadMesh.getNx();
48  auto ny = _quadMesh.getNy();
49  // Matrix sizing
50  _power_dis.resize((ny - 1) * (nx - 1), 1);
51  _power_dis.setZero();
52  _pin_power_correction.resize((ny - 1) * (nx - 1), 1);
53  _pin_power_correction.setOnes();
54 
55  Real vin;
56  std::ifstream inFile;
57 
58  inFile.open(_filename);
59  if (!inFile)
60  mooseError(name(), "unable to open file : ", _filename);
61 
62  while (inFile >> vin)
63  _numberoflines += 1;
64 
65  if (inFile.fail() && !inFile.eof())
66  mooseError(name(), " non numerical input at line : ", _numberoflines);
67 
68  if (_numberoflines != (ny - 1) * (nx - 1))
69  mooseError(name(), " Radial profile file doesn't have correct size : ", (ny - 1) * (nx - 1));
70  inFile.close();
71 
72  inFile.open(_filename);
73  int i(0);
74  while (inFile >> vin)
75  {
76  _power_dis(i, 0) = vin;
77  i++;
78  }
79  inFile.close();
80  _console << " Power distribution matrix :\n" << _power_dis << " \n";
81 }
82 
83 void
85 {
86  if (processor_id() > 0)
87  return;
88 
89  auto nx = _quadMesh.getNx();
90  auto ny = _quadMesh.getNy();
91  auto n_pins = (nx - 1) * (ny - 1);
92  auto nz = _quadMesh.getNumOfAxialCells();
93  auto z_grid = _quadMesh.getZGrid();
94  auto heated_length = _quadMesh.getHeatedLength();
95  auto unheated_length_entry = _quadMesh.getHeatedLengthEntry();
96  auto sum = _power_dis.sum();
97 
98  // full (100%) power of one pin [W]
99  auto fpin_power = _power / sum;
100  // actual pin power [W]
101  _ref_power = _power_dis * fpin_power;
102  // Convert the actual pin power to a linear heat rate [W/m]
103  _ref_qprime = _ref_power / heated_length;
104 
105  _estimate_power.resize(n_pins, 1);
106  _estimate_power.setZero();
107  for (unsigned int iz = 1; iz < nz + 1; iz++)
108  {
109  // Compute axial location of nodes.
110  auto z2 = z_grid[iz];
111  auto z1 = z_grid[iz - 1];
112  Point p1(0, 0, z1 - unheated_length_entry);
113  Point p2(0, 0, z2 - unheated_length_entry);
114  auto heat1 = _axial_heat_rate.value(_t, p1);
115  auto heat2 = _axial_heat_rate.value(_t, p2);
116  if (MooseUtils::absoluteFuzzyGreaterThan(z2, unheated_length_entry) &&
117  MooseUtils::absoluteFuzzyLessThan(z1, unheated_length_entry + heated_length))
118  {
119  // cycle through pins
120  for (unsigned int i_pin = 0; i_pin < n_pins; i_pin++)
121  {
122  // Compute the height of this element.
123  auto dz = z2 - z1;
124 
125  // calculation of power for the first heated segment if nodes don't align
126  if (MooseUtils::absoluteFuzzyGreaterThan(z2, unheated_length_entry) &&
127  MooseUtils::absoluteFuzzyLessThan(z1, unheated_length_entry))
128  {
129  heat1 = 0.0;
130  }
131 
132  // calculation of power for the last heated segment if nodes don't align
133  if (MooseUtils::absoluteFuzzyGreaterThan(z2, unheated_length_entry + heated_length) &&
134  MooseUtils::absoluteFuzzyLessThan(z1, unheated_length_entry + heated_length))
135  {
136  heat2 = 0.0;
137  }
138 
139  _estimate_power(i_pin) += _ref_qprime(i_pin) * (heat1 + heat2) * dz / 2.0;
140  }
141  }
142  }
143 
144  // if a Pin has zero power (_ref_qprime(i_pin) = 0) then I need to avoid dividing by zero. I
145  // divide by a wrong non-zero number which is not correct but this error doesn't mess things
146  // cause _ref_qprime(i_pin) = 0.0
147  auto total_power = 0.0;
148  for (unsigned int i_pin = 0; i_pin < n_pins; i_pin++)
149  {
150  total_power += _estimate_power(i_pin);
151  if (_estimate_power(i_pin) == 0.0)
152  _estimate_power(i_pin) = 1.0;
153  }
154  // We need to correct the linear power assigned to the nodes of each pin
155  // so that the total power calculated by the trapezoidal rule agrees with the power assigned
156  // by the user.
158  _console << "###########################################" << std::endl;
159  _console << "Total power estimation by Aux kernel before correction: " << total_power << " [W] "
160  << std::endl;
161  _console << "Aux Power correction vector :\n" << _pin_power_correction << " \n";
162 }
163 
164 Real
166 {
167  Point p = *_current_node;
168  auto heated_length = _quadMesh.getHeatedLength();
169  auto unheated_length_entry = _quadMesh.getHeatedLengthEntry();
170  Point p1(0, 0, unheated_length_entry);
171  Point P = p - p1;
172  auto pin_mesh_exist = _quadMesh.pinMeshExist();
173 
175  if (MooseUtils::absoluteFuzzyGreaterEqual(p(2), unheated_length_entry) &&
176  MooseUtils::absoluteFuzzyLessEqual(p(2), unheated_length_entry + heated_length))
177  {
178  if (pin_mesh_exist)
179  {
180  // project axial heat rate on pins
181  auto i_pin = _quadMesh.getPinIndexFromPoint(p);
182  return _ref_qprime(i_pin) * _pin_power_correction(i_pin) * _axial_heat_rate.value(_t, P);
183  }
184  else
185  {
186  // project axial heat rate on subchannels
187  auto i_ch = _quadMesh.getSubchannelIndexFromPoint(p);
188  // if we are adjacent to the heated part of the fuel Pin
189  auto heat_rate = 0.0;
190  for (auto i_pin : _quadMesh.getChannelPins(i_ch))
191  {
192  heat_rate += 0.25 * _ref_qprime(i_pin) * _pin_power_correction(i_pin) *
194  }
195  return heat_rate;
196  }
197  }
198  else
199  return 0.0;
200 }
Eigen::MatrixXd _pin_power_correction
The correction that will be applied to the estimated calculation [unitless].
const QuadSubChannelMesh & _quadMesh
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
virtual const std::vector< Real > & getZGrid() const
Get axial location of layers.
Eigen::MatrixXd _estimate_power
Matrix which will hold the total estimated power of each pin [W].
const Node *const & _current_node
static InputParameters validParams()
Creates the mesh of subchannels in a quadrilateral lattice.
Eigen::MatrixXd _ref_power
Actual pin power [W].
Eigen::MatrixXd _ref_qprime
Average linear heat rate over the whole pin [W/m].
void addRequiredParam(const std::string &name, const std::string &doc_string)
const std::string & name() const
unsigned int _numberoflines
The number of lines associated with the radial power profile .txt file.
Sets the axial heat rate for each pin according to a radial power distribution and a user defined axi...
unsigned int getSubchannelIndexFromPoint(const Point &p) const override
Return a subchannel index for a given physical point p
virtual const Real & getHeatedLength() const
Return heated length.
virtual bool pinMeshExist() const override
Return if Pin Mesh exists or not.
const T & getConstMesh(const MooseMesh &mesh)
function to cast const mesh
Definition: SCM.h:21
Eigen::MatrixXd _power_dis
matrix that holds the values of the relative pin power
const PostprocessorValue & _power
The total power of the assembly.
virtual void initialSetup() override
virtual Real computeValue() override
virtual unsigned int getNumOfAxialCells() const
Return the number of axial cells.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual const unsigned int & getNy() const
Number of subchannels in the -y direction.
registerMooseObjectRenamed("SubChannelApp", QuadPowerAux, "06/30/2025 24:00", SCMQuadPowerAux)
std::string _filename
The name of the radial power profile file.
void mooseError(Args &&... args) const
void addClassDescription(const std::string &doc_string)
unsigned int getPinIndexFromPoint(const Point &p) const override
Return a pin index for a given physical point p
static InputParameters validParams()
virtual const unsigned int & getNx() const
Number of subchannels in the -x direction.
const ConsoleStream _console
virtual Real value(Real t, const Point &p) const
virtual const std::vector< unsigned int > & getChannelPins(unsigned int i_chan) const override
Return a vector of pin indices for a given channel index.
processor_id_type processor_id() const
const Function & _axial_heat_rate
Definition: SCM.h:16
virtual const Real & getHeatedLengthEntry() const
Return unheated length at entry.
registerMooseObject("SubChannelApp", SCMQuadPowerAux)
SCMQuadPowerAux(const InputParameters &params)