ADVolumeJunction1PhaseUserObject

Computes and caches flux and residual vectors for a 1-phase volume junction

This user object is used with the VolumeJunction1Phase component. It computes the fluxes that are used in ADVolumeJunction1PhaseBC for each of the connected flow channels and the residuals that are used in ADVolumeJunctionAdvectionScalarKernel for each of the junction's degrees of freedom.

Input Parameters

ACross-sectional area of connected flow channels
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Cross-sectional area of connected flow channels
A_refReference area [m^2]
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Reference area [m^2]
KForm loss coefficient [-]
C++ Type:double
Unit:(no unit assumed)
Controllable:Yes
Description:Form loss coefficient [-]
boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
fpFluid properties user object name
C++ Type:UserObjectName
Controllable:No
Description:Fluid properties user object name
normalsFlow channel outward normals or junction inward normals
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Flow channel outward normals or junction inward normals
numerical_flux_namesThe names of the user objects that compute the numerical flux at each flow channel.
C++ Type:std::vector<UserObjectName>
Controllable:No
Description:The names of the user objects that compute the numerical flux at each flow channel.
rhoArho*A of the connected flow channels
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:rho*A of the connected flow channels
rhoEArhoE*A of the connected flow channels
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:rhoE*A of the connected flow channels
rhoEVrho*E*V of the junction
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:rho*E*V of the junction
rhoVrho*V of the junction
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:rho*V of the junction
rhouArhou*A of the connected flow channels
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:rhou*A of the connected flow channels
rhouVrho*u*V of the junction
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:rho*u*V of the junction
rhovVrho*v*V of the junction
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:rho*v*V of the junction
rhowVrho*w*V of the junction
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:rho*w*V of the junction
volumeVolume of the junction
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Volume of the junction

Required Parameters

apply_velocity_scalingFalseSet to true to apply the scaling to the normal velocity. See documentation for more information.
Default:False
C++ Type:bool
Controllable:No
Description:Set to true to apply the scaling to the normal velocity. See documentation for more information.
junction_subdomain_id65535Junction subdomain ID (required if 'use_scalar_variables' is 'false')
Default:65535
C++ Type:unsigned short
Controllable:No
Description:Junction subdomain ID (required if 'use_scalar_variables' is 'false')
processor_idsProcessor IDs owning each connected flow channel element
C++ Type:std::vector<unsigned int>
Controllable:No
Description:Processor IDs owning each connected flow channel element
use_scalar_variablesTrueTrue if the junction variables are scalar variables
Default:True
C++ Type:bool
Controllable:No
Description:True if the junction variables are scalar variables

Optional Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, TRANSFER
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Material Property Retrieval Parameters

Child Objects

(modules/thermal_hydraulics/include/userobjects/ADShaftConnectedCompressor1PhaseUserObject.h)
(modules/thermal_hydraulics/include/userobjects/ADShaftConnectedPump1PhaseUserObject.h)
(modules/thermal_hydraulics/include/userobjects/ADPump1PhaseUserObject.h)
(modules/thermal_hydraulics/include/userobjects/ADShaftConnectedTurbine1PhaseUserObject.h)
(modules/thermal_hydraulics/include/userobjects/ADJunctionParallelChannels1PhaseUserObject.h)

References

No citations exist within this document.

(modules/thermal_hydraulics/include/userobjects/ADShaftConnectedCompressor1PhaseUserObject.h)

// 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 "ADVolumeJunction1PhaseUserObject.h"
#include "ADShaftConnectableUserObjectInterface.h"

class SinglePhaseFluidProperties;
class ADNumericalFlux3EqnBase;

/**
 * Computes and caches flux and residual vectors for a 1-phase compressor
 *
 * This class computes and caches the following quantities:
 * \li residuals for the scalar variables associated with the compressor,
 * \li fluxes between the flow channels and the compressor, and
 * \li compressor torque and inertia which are passed to the connected shaft.
 */
class ADShaftConnectedCompressor1PhaseUserObject : public ADVolumeJunction1PhaseUserObject,
                                                   public ADShaftConnectableUserObjectInterface
{
public:
  ADShaftConnectedCompressor1PhaseUserObject(const InputParameters & params);

  virtual void initialSetup() override;
  virtual void initialize() override;
  virtual void execute() override;

  /// Isentropic torque computed in the 1-phase shaft-connected compressor
  ADReal getIsentropicTorque() const;
  /// Dissipation torque computed in the 1-phase shaft-connected compressor
  ADReal getDissipationTorque() const;
  /// Friction torque computed in the 1-phase shaft-connected compressor
  ADReal getFrictionTorque() const;
  /// Compressor head computed in the 1-phase shaft-connected compressor
  ADReal getCompressorDeltaP() const;
  /// Gets the pressure ratio
  ADReal getPressureRatio() const;
  /// Gets the efficiency
  ADReal getEfficiency() const;
  /// Gets the relative corrected mass flow rate
  ADReal getRelativeCorrectedMassFlowRate() const;
  /// Gets the elative corrected shaft speed
  ADReal getRelativeCorrectedSpeed() const;

  virtual void finalize() override;
  virtual void threadJoin(const UserObject & uo) override;

protected:
  virtual void computeFluxesAndResiduals(const unsigned int & c) override;

  /// Direction of the compressor outlet
  Point _di_out;
  /// Treat the compressor as a turbine?
  const bool _treat_as_turbine;
  /// Rated compressor speed
  const Real & _omega_rated;
  /// Rated compressor mass flow rate
  const Real & _mdot_rated;
  /// Rated compressor inlet stagnation fluid density
  const Real & _rho0_rated;
  /// Rated compressor inlet stagnation sound speed
  const Real & _c0_rated;
  /// Compressor speed threshold for friction
  const Real & _speed_cr_fr;
  /// Compressor friction constant
  const Real & _tau_fr_const;
  /// Compressor friction coefficients
  const std::vector<Real> & _tau_fr_coeff;
  /// Compressor speed threshold for inertia
  const Real & _speed_cr_I;
  /// Compressor inertia constant
  const Real & _inertia_const;
  /// Compressor inertia coefficients
  const std::vector<Real> & _inertia_coeff;
  /// Compressor speeds which correspond to Rp and eff function order
  const std::vector<Real> & _speeds;
  /// Names of the pressure ratio functions
  const std::vector<FunctionName> & _Rp_function_names;
  /// Names of the adiabatic efficiency functions
  const std::vector<FunctionName> & _eff_function_names;
  /// Size of vector _speeds
  const unsigned int _n_speeds;
  /// Pressure ratio functions
  std::vector<const Function *> _Rp_functions;
  /// Adiabatic efficiency functions
  std::vector<const Function *> _eff_functions;
  /// Minimum pressure ratio
  const Real & _Rp_min;
  /// Maximum pressure ratio
  const Real & _Rp_max;

  /// Compressor name
  const std::string & _compressor_name;

  const ADVariableValue & _omega;

  /// Compressor isentropic torque
  ADReal _isentropic_torque;
  /// Compressor dissipation torque
  ADReal _dissipation_torque;
  /// Compressor friction torque
  ADReal _friction_torque;
  /// Compressor delta p
  ADReal _delta_p;
  /// Pressure ratio
  ADReal _Rp;
  /// Efficiency
  ADReal _eff;
  /// relative corrected mass flow rate
  ADReal _flow_rel_corr;
  /// relative corrected shaft speed
  ADReal _speed_rel_corr;

  /// Jacobian entries of junction variables wrt shaft variables
  std::vector<DenseMatrix<Real>> _residual_jacobian_omega_var;

public:
  static InputParameters validParams();
};

(modules/thermal_hydraulics/include/userobjects/ADShaftConnectedPump1PhaseUserObject.h)

// 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 "ADVolumeJunction1PhaseUserObject.h"
#include "ADShaftConnectableUserObjectInterface.h"
#include "ADWeightedTransition.h"

class SinglePhaseFluidProperties;
class ADNumericalFlux3EqnBase;

/**
 * Computes and caches flux and residual vectors for a 1-phase pump
 *
 * This class computes and caches the following quantities:
 * \li residuals for the scalar variables associated with the pump,
 * \li fluxes between the flow channels and the pump, and
 * \li pump torque and inertia which are passed to the connected shaft.
 */
class ADShaftConnectedPump1PhaseUserObject : public ADVolumeJunction1PhaseUserObject,
                                             public ADShaftConnectableUserObjectInterface
{
public:
  ADShaftConnectedPump1PhaseUserObject(const InputParameters & params);

  virtual void initialSetup() override;
  virtual void initialize() override;
  virtual void execute() override;

  /// Hydraulic torque computed in the 1-phase shaft-connected pump
  ADReal getHydraulicTorque() const;
  /// Friction torque computed in the 1-phase shaft-connected pump
  ADReal getFrictionTorque() const;
  /// Pump head computed in the 1-phase shaft-connected pump
  ADReal getPumpHead() const;

  virtual void finalize() override;
  virtual void threadJoin(const UserObject & uo) override;

protected:
  virtual void computeFluxesAndResiduals(const unsigned int & c) override;

  /// Direction of the pump outlet
  Point _di_out;
  /// Gravity constant
  const Real & _g;
  /// Rated pump speed
  const Real & _omega_rated;
  /// Rated pump volumetric flow rate
  const Real & _volumetric_rated;
  /// Rated pump head
  const Real & _head_rated;
  /// Rated pump torque
  const Real & _torque_rated;
  /// Rated pump density
  const Real & _density_rated;
  /// Pump speed threshold for friction
  const Real & _speed_cr_fr;
  /// Pump friction constant
  const Real & _tau_fr_const;
  /// Pump friction coefficients
  const std::vector<Real> & _tau_fr_coeff;
  /// Pump speed threshold for inertia
  const Real & _speed_cr_I;
  /// Pump inertia constant
  const Real & _inertia_const;
  /// Pump inertia coefficients
  const std::vector<Real> & _inertia_coeff;
  /// Function to compute data for pump head
  const Function & _head;
  /// Function to compute data for pump torque
  const Function & _torque_hydraulic;
  /// Pump name
  const std::string & _pump_name;
  /// Shaft speed
  const ADVariableValue & _omega;
  /// Transition width for the sign of the frictional torque when speed is 0
  const Real & _transition_width;
  /// Transition for the sign of the frictional torque when speed is 0
  const ADWeightedTransition _transition_friction;

  /// Pump hydraulic torque
  ADReal _hydraulic_torque;
  /// Pump friction torque
  ADReal _friction_torque;
  /// Pump head
  ADReal _pump_head;

  /// Jacobian entries of junction variables wrt shaft variables
  std::vector<DenseMatrix<Real>> _residual_jacobian_omega_var;

public:
  static InputParameters validParams();
};

(modules/thermal_hydraulics/include/userobjects/ADPump1PhaseUserObject.h)

// 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 "ADVolumeJunction1PhaseUserObject.h"

/**
 * Computes and caches flux and residual vectors for a 1-phase pump
 *
 * This class computes and caches the following quantities:
 * \li residuals for the scalar variables associated with the pump, and
 * \li fluxes between the flow channels and the pump.
 */
class ADPump1PhaseUserObject : public ADVolumeJunction1PhaseUserObject
{
public:
  ADPump1PhaseUserObject(const InputParameters & params);

protected:
  virtual void computeFluxesAndResiduals(const unsigned int & c) override;

  /// Pump head, [m]
  const Real & _head;
  /// Gravity constant, i.e., 9.8 [m/s^2]
  const Real & _g;

public:
  static InputParameters validParams();
};

(modules/thermal_hydraulics/include/userobjects/ADShaftConnectedTurbine1PhaseUserObject.h)

// 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 "ADVolumeJunction1PhaseUserObject.h"
#include "ADShaftConnectableUserObjectInterface.h"

class SinglePhaseFluidProperties;
class ADNumericalFlux3EqnBase;

/**
 * Computes and caches flux and residual vectors for a 1-phase turbine
 *
 * This class computes and caches the following quantities:
 * \li residuals for the scalar variables associated with the turbine,
 * \li fluxes between the flow channels and the turbine, and
 * \li turbine torque and inertia which are passed to the connected shaft.
 */
class ADShaftConnectedTurbine1PhaseUserObject : public ADVolumeJunction1PhaseUserObject,
                                                public ADShaftConnectableUserObjectInterface
{
public:
  ADShaftConnectedTurbine1PhaseUserObject(const InputParameters & params);

  virtual void initialSetup() override;
  virtual void initialize() override;
  virtual void execute() override;

  /// Driving torque computed in the 1-phase shaft-connected turbine
  ADReal getDrivingTorque() const;
  /// Flow coefficient computed in the 1-phase shaft-connected turbine
  ADReal getFlowCoefficient() const;
  /// Friction torque computed in the 1-phase shaft-connected turbine
  ADReal getFrictionTorque() const;
  /// Turbine head computed in the 1-phase shaft-connected turbine
  ADReal getTurbineDeltaP() const;
  /// Turbine power computed in the 1-phase shaft-connected turbine
  ADReal getTurbinePower() const;

  virtual void finalize() override;
  virtual void threadJoin(const UserObject & uo) override;

protected:
  virtual void computeFluxesAndResiduals(const unsigned int & c) override;

  /// Direction of the turbine outlet
  Point _di_out;
  /// Rated turbine speed
  const Real & _omega_rated;
  /// Turbine wheel diameter
  const Real & _D_wheel;
  /// Turbine speed threshold for friction
  const Real & _speed_cr_fr;
  /// Turbine friction constant
  const Real & _tau_fr_const;
  /// Turbine friction coefficients
  const std::vector<Real> & _tau_fr_coeff;
  /// Turbine speed threshold for inertia
  const Real & _speed_cr_I;
  /// Turbine inertia constant
  const Real & _inertia_const;
  /// Turbine inertia coefficients
  const std::vector<Real> & _inertia_coeff;
  /// Function to compute data for turbine head
  const Function & _head_coefficient;
  /// Function to compute data for turbine power
  const Function & _power_coefficient;

  /// Turbine name
  const std::string & _turbine_name;
  /// Connected shaft speed
  const ADVariableValue & _omega;

  /// Turbine driving torque
  ADReal _driving_torque;
  /// Turbine friction torque
  ADReal _friction_torque;
  /// Turbine flow coefficient - independent variable in user supplied head and power functions
  ADReal _flow_coeff;
  /// Turbine pressure drop
  ADReal _delta_p;
  /// Turbine power
  ADReal _power;

  /// Jacobian entries of junction variables wrt shaft variables
  std::vector<DenseMatrix<Real>> _residual_jacobian_omega_var;

public:
  static InputParameters validParams();
};

(modules/thermal_hydraulics/include/userobjects/ADJunctionParallelChannels1PhaseUserObject.h)

// 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 "ADVolumeJunction1PhaseUserObject.h"

class SinglePhaseFluidProperties;
class ADNumericalFlux3EqnBase;

/**
 * Computes and caches flux and residual vectors for a 1-phase junction that connects flow channels
 * that are parallel
 *
 * This class computes and caches the following quantities:
 * \li residuals for the scalar variables associated with the junction, and
 * \li fluxes between the flow channels and the junction.
 */
class ADJunctionParallelChannels1PhaseUserObject : public ADVolumeJunction1PhaseUserObject
{
public:
  ADJunctionParallelChannels1PhaseUserObject(const InputParameters & params);

  virtual void initialize() override;
  virtual void threadJoin(const UserObject & uo) override;
  virtual void finalize() override;

protected:
  virtual void computeFluxesAndResiduals(const unsigned int & c) override;

  /// Pressure material property
  const ADMaterialProperty<Real> & _p;

  /// Channel direction for the first connection
  RealVectorValue _dir_c0;
  /// Flow direction for the first connection
  RealVectorValue _d_flow;

  //// Stored pressure for each connection
  std::vector<ADReal> _stored_pA;

  /// Areas at each connection
  std::vector<ADReal> _areas;
  /// Check if the connection is an inlet
  std::vector<bool> _is_inlet;

  /// Connection index for inlet flow channel connections
  std::vector<unsigned int> _c_in;
  /// Connection index for outlet flow channel connections
  std::vector<unsigned int> _c_out;
  /// Connection index for connections that contribute to the wall pressure
  std::vector<unsigned int> _c_wall;

  /// Name of the associated component
  const std::string & _component_name;

public:
  static InputParameters validParams();
};

Input Parameters
Child Objects
References