https://mooseframework.inl.gov
SCMTriPowerAux.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 "SCMTriPowerAux.h"
11 #include "Function.h"
12 #include "TriSubChannelMesh.h"
13 #include "SCM.h"
14 
15 registerMooseObject("SubChannelApp", SCMTriPowerAux);
16 registerMooseObjectRenamed("SubChannelApp", TriPowerAux, "06/30/2025 24:00", SCMTriPowerAux);
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 triangular 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  _triMesh(SCM::getConstMesh<TriSubChannelMesh>(_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  auto n_pins = _triMesh.getNumOfPins();
47  // Matrix sizing
48  _power_dis.resize(n_pins, 1);
49  _power_dis.setZero();
50  _pin_power_correction.resize(n_pins, 1);
51  _pin_power_correction.setOnes();
52 
53  Real vin;
54  std::ifstream inFile;
55 
56  inFile.open(_filename);
57  if (!inFile)
58  mooseError(name(), ": Unable to open file: ", _filename);
59 
60  while (inFile >> vin)
61  _numberoflines += 1;
62 
63  if (inFile.fail() && !inFile.eof())
64  mooseError(name(), ": Non numerical input at line: ", _numberoflines);
65 
66  if (_numberoflines != n_pins)
67  mooseError(name(), ": Radial profile file doesn't have correct size: ", n_pins);
68  inFile.close();
69 
70  inFile.open(_filename);
71  int i = 0;
72  while (inFile >> vin)
73  {
74  _power_dis(i, 0) = vin;
75  i++;
76  }
77  inFile.close();
78 }
79 
80 void
82 {
83  if (processor_id() > 0)
84  return;
85 
86  auto heated_length = _triMesh.getHeatedLength();
87  auto sum = _power_dis.sum();
88  // full (100%) power of one pin [W]
89  auto fpin_power = _power / sum;
90  // actual pin power [W]
91  _ref_power = _power_dis * fpin_power;
92  // Convert the actual pin power to a linear heat rate [W/m]
93  _ref_qprime = _ref_power / heated_length;
94 
95  auto n_pins = _triMesh.getNumOfPins();
96  auto nz = _triMesh.getNumOfAxialCells();
97  auto z_grid = _triMesh.getZGrid();
98  auto unheated_length_entry = _triMesh.getHeatedLengthEntry();
99 
100  _estimate_power.resize(n_pins, 1);
101  _estimate_power.setZero();
102  for (unsigned int iz = 1; iz < nz + 1; iz++)
103  {
104  // Compute axial location of nodes.
105  auto z2 = z_grid[iz];
106  auto z1 = z_grid[iz - 1];
107  Point p1(0, 0, z1 - unheated_length_entry);
108  Point p2(0, 0, z2 - unheated_length_entry);
109  auto heat1 = _axial_heat_rate.value(_t, p1);
110  auto heat2 = _axial_heat_rate.value(_t, p2);
111  if (MooseUtils::absoluteFuzzyGreaterThan(z2, unheated_length_entry) &&
112  MooseUtils::absoluteFuzzyLessThan(z1, unheated_length_entry + heated_length))
113  {
114  // cycle through pins
115  for (unsigned int i_pin = 0; i_pin < n_pins; i_pin++)
116  {
117  // Compute the height of this element.
118  auto dz = z2 - z1;
119 
120  // calculation of power for the first heated segment if nodes don't align
121  if (MooseUtils::absoluteFuzzyGreaterThan(z2, unheated_length_entry) &&
122  MooseUtils::absoluteFuzzyLessThan(z1, unheated_length_entry))
123  {
124  heat1 = 0.0;
125  }
126 
127  // calculation of power for the last heated segment if nodes don't align
128  if (MooseUtils::absoluteFuzzyGreaterThan(z2, unheated_length_entry + heated_length) &&
129  MooseUtils::absoluteFuzzyLessThan(z1, unheated_length_entry + heated_length))
130  {
131  heat2 = 0.0;
132  }
133  _estimate_power(i_pin) += _ref_qprime(i_pin) * (heat1 + heat2) * dz / 2.0;
134  }
135  }
136  }
137 
138  // if a Pin has zero power (_ref_qprime(i_pin) = 0) then I need to avoid dividing by zero. I
139  // divide by a wrong non-zero number which is not correct but this error doesn't mess things cause
140  // _ref_qprime(i_pin) = 0.0
141  auto total_power = 0.0;
142  for (unsigned int i_pin = 0; i_pin < n_pins; i_pin++)
143  {
144  total_power += _estimate_power(i_pin);
145  if (_estimate_power(i_pin) == 0.0)
146  _estimate_power(i_pin) = 1.0;
147  }
148  // We need to correct the linear power assigned to the nodes of each pin
149  // so that the total power calculated by the trapezoidal rule agrees with the power assigned by
150  // the user.
152  _console << "###########################################" << std::endl;
153  _console << "Total power estimation by Aux kernel before correction: " << total_power << " [W] "
154  << std::endl;
155  _console << "Aux Power correction vector :\n" << _pin_power_correction << " \n";
156 }
157 
158 Real
160 {
161  Point p = *_current_node;
162  auto heat_rate = 0.0;
163  auto heated_length = _triMesh.getHeatedLength();
164  auto unheated_length_entry = _triMesh.getHeatedLengthEntry();
165  Point p1(0, 0, unheated_length_entry);
166  Point P = p - p1;
167  auto pin_triMesh_exist = _triMesh.pinMeshExist();
168 
170  if (MooseUtils::absoluteFuzzyGreaterEqual(p(2), unheated_length_entry) &&
171  MooseUtils::absoluteFuzzyLessEqual(p(2), unheated_length_entry + heated_length))
172  {
173  if (pin_triMesh_exist)
174  {
175  // project axial heat rate on pins
176  auto i_pin = _triMesh.getPinIndexFromPoint(p);
177  return _ref_qprime(i_pin) * _pin_power_correction(i_pin) * _axial_heat_rate.value(_t, P);
178  }
179  else
180  {
181  // Determine which subchannel this point is in.
182  auto i_ch = _triMesh.getSubchannelIndexFromPoint(p);
183  auto subch_type = _triMesh.getSubchannelType(i_ch);
184  // project axial heat rate on subchannels
185  {
186  double factor;
187  switch (subch_type)
188  {
190  factor = 1.0 / 6.0;
191  break;
192  case EChannelType::EDGE:
193  factor = 1.0 / 4.0;
194  break;
196  factor = 1.0 / 6.0;
197  break;
198  default:
199  return 0.0; // handle invalid subch_type if needed
200  }
201  for (auto i_pin : _triMesh.getChannelPins(i_ch))
202  {
203  heat_rate += factor * _ref_qprime(i_pin) * _pin_power_correction(i_pin) *
205  }
206  return heat_rate;
207  }
208  }
209  }
210  else
211  return 0.0;
212 }
Eigen::MatrixXd _power_dis
matrix that holds the values of the relative pin power
virtual bool pinMeshExist() const override
Return if Pin Mesh exists or not.
virtual EChannelType getSubchannelType(unsigned int index) const override
Return the type of the subchannel for given subchannel index.
unsigned int _numberoflines
The number of lines associated with the radial power profile .txt file.
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.
const Node *const & _current_node
virtual unsigned int getSubchannelIndexFromPoint(const Point &p) const override
Return a subchannel index for a given physical point p
registerMooseObjectRenamed("SubChannelApp", TriPowerAux, "06/30/2025 24:00", SCMTriPowerAux)
const Function & _axial_heat_rate
virtual Real computeValue() override
registerMooseObject("SubChannelApp", SCMTriPowerAux)
static InputParameters validParams()
void addRequiredParam(const std::string &name, const std::string &doc_string)
const TriSubChannelMesh & _triMesh
const std::string & name() const
virtual const Real & getHeatedLength() const
Return heated length.
const T & getConstMesh(const MooseMesh &mesh)
function to cast const mesh
Definition: SCM.h:21
virtual void initialSetup() override
virtual unsigned int getPinIndexFromPoint(const Point &p) const override
Return a pin index for a given physical point p
Eigen::MatrixXd _ref_qprime
Average linear heat rate over the whole pin [W/m].
Mesh class for triangular, edge and corner subchannels for hexagonal lattice fuel assemblies...
virtual unsigned int getNumOfAxialCells() const
Return the number of axial cells.
virtual unsigned int getNumOfPins() const override
Return the number of pins.
Sets the axial heat rate for each pin according to a radial power distribution and a user defined axi...
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Eigen::MatrixXd _ref_power
Actual pin power [W].
std::string _filename
The name of the radial power profile file.
const PostprocessorValue & _power
The total power of the assembly.
void mooseError(Args &&... args) const
void addClassDescription(const std::string &doc_string)
static InputParameters validParams()
const ConsoleStream _console
virtual Real value(Real t, const Point &p) const
processor_id_type processor_id() 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.
Eigen::MatrixXd _pin_power_correction
The correction that will be applied to the estimated calculation [unitless].
SCMTriPowerAux(const InputParameters &params)
Definition: SCM.h:16
virtual const Real & getHeatedLengthEntry() const
Return unheated length at entry.
Eigen::MatrixXd _estimate_power
Matrix which will hold the total estimated power of each pin [W].