Advanced Multi-Physics (AMP)
On-Line Documentation
Functions | Variables
AMP::Operator::Subchannel Namespace Reference

Functions

std::shared_ptr< const SubchannelOperatorParametersconvert (std::shared_ptr< const OperatorParameters >)
 
AMP::LinearAlgebra::Vector::shared_ptr getCladHydraulicDiameter (std::shared_ptr< AMP::Mesh::Mesh > clad, std::shared_ptr< AMP::Mesh::Mesh > subchannel, AMP::AMP_MPI comm)
 Function to get the hydraulic diameter on the clad surface.
 
void getCladProperties (AMP::AMP_MPI comm, std::shared_ptr< AMP::Mesh::Mesh > clad, std::vector< double > &x, std::vector< double > &y, std::vector< double > &diam)
 Function to get the coordinates of the clad.
 
std::vector< double > getHeatFluxClad (std::vector< double > z, std::vector< AMP::Mesh::MeshElementID > face_ids, double channelDiam, double reynolds, double prandtl, double fraction, std::shared_ptr< SubchannelPhysicsModel > subchannelPhysicsModel, AMP::LinearAlgebra::Vector::const_shared_ptr flow, AMP::LinearAlgebra::Vector::const_shared_ptr clad_temp)
 Function to get the heat flux of the rod.
 
std::vector< double > getHeatFluxGeneration (std::string shape, std::vector< double > z, double diam, double Q_tot)
 Function to get the heat flux of the rod.
 
std::vector< double > getHeatFluxGenerationWithDiscretizationError (std::string shape, std::vector< double > z, double diam, double Q_tot)
 Function to get the heat flux of the rod; uses a midpoint average, leading to discretization error.
 
size_t getNumberOfSubchannels (std::shared_ptr< AMP::Mesh::Mesh > subchannel)
 Function to get the number of subchannels from the mesh.
 
void getSubchannelProperties (std::shared_ptr< AMP::Mesh::Mesh > subchannel, const std::vector< double > &clad_x, const std::vector< double > &clad_y, const std::vector< double > &clad_d, std::vector< double > &x, std::vector< double > &y, std::vector< double > &area, std::vector< double > &diam, std::vector< double > &rod_diameter, std::vector< double > &channel_fraction)
 Function to get some basic properties for each subchannel based on the mesh.
 
std::shared_ptr< AMP::Mesh::MeshsubsetForSubchannel (std::shared_ptr< AMP::Mesh::Mesh > subchannel, size_t i, size_t j)
 Function to subset the subchannel mesh for a particular subchannel.
 

Variables

constexpr double scaleAxialMassFlowRate
 
constexpr double scaleEnthalpy
 
constexpr double scaleLateralMassFlowRate
 
constexpr double scalePressure
 

Function Documentation

◆ convert()

std::shared_ptr< const SubchannelOperatorParameters > AMP::Operator::Subchannel::convert ( std::shared_ptr< const OperatorParameters )

◆ getCladHydraulicDiameter()

AMP::LinearAlgebra::Vector::shared_ptr AMP::Operator::Subchannel::getCladHydraulicDiameter ( std::shared_ptr< AMP::Mesh::Mesh clad,
std::shared_ptr< AMP::Mesh::Mesh subchannel,
AMP::AMP_MPI  comm 
)

Function to get the hydraulic diameter on the clad surface.

This function returns the hydraulic diameter of the subchannels on the clad surface

Parameters
cladClad mesh
subchannelSubchannel mesh
commCommunicator to use for operatation (must be >= comm of both clad and subchannel, may be comm_world)

◆ getCladProperties()

void AMP::Operator::Subchannel::getCladProperties ( AMP::AMP_MPI  comm,
std::shared_ptr< AMP::Mesh::Mesh clad,
std::vector< double > &  x,
std::vector< double > &  y,
std::vector< double > &  diam 
)

Function to get the coordinates of the clad.

This function returns the coordinates and diameter of the clad meshes across all processors

Parameters
[in]commCommunicator over which we want to gather the results (must be >= clad mesh comm)
[in]cladMultimesh containing the clad meshes
[out]xThe x-coordinates of the clad
[out]yThe y-coordinates of the clad
[out]diamThe diameters of the clad

◆ getHeatFluxClad()

std::vector< double > AMP::Operator::Subchannel::getHeatFluxClad ( std::vector< double >  z,
std::vector< AMP::Mesh::MeshElementID face_ids,
double  channelDiam,
double  reynolds,
double  prandtl,
double  fraction,
std::shared_ptr< SubchannelPhysicsModel subchannelPhysicsModel,
AMP::LinearAlgebra::Vector::const_shared_ptr  flow,
AMP::LinearAlgebra::Vector::const_shared_ptr  clad_temp 
)

Function to get the heat flux of the rod.

This function returns the heat flux of the rod (W/m^2)

Parameters
zThe axial positions of the faces
face_idsElement ids of the faces of interest (only used for source="averageCladdingTemperature")
channelDiamThe effective channel diameter
reynoldsThe reynolds number
prandtlThe prandtl number
fractionThe fraction of a rod in the channel
subchannelPhysicsModelThe subchannel physics model
flowThe flow vector (h and P) (only used for source="averageCladdingTemperature")
clad_tempThe clad temperature mapped onto the faces (only used for source="averageCladdingTemperature")

◆ getHeatFluxGeneration()

std::vector< double > AMP::Operator::Subchannel::getHeatFluxGeneration ( std::string  shape,
std::vector< double >  z,
double  diam,
double  Q_tot 
)

Function to get the heat flux of the rod.

This function returns the heat flux of the rod (W/m^2) assuming a given generation rate

Parameters
shapeThe heat shape
zThe axial positions of the faces (m)
diamThe diameter of the fuel rods (m)
Q_totThe total heat generation rate (W)

◆ getHeatFluxGenerationWithDiscretizationError()

std::vector< double > AMP::Operator::Subchannel::getHeatFluxGenerationWithDiscretizationError ( std::string  shape,
std::vector< double >  z,
double  diam,
double  Q_tot 
)

Function to get the heat flux of the rod; uses a midpoint average, leading to discretization error.

This function returns the heat flux of the rod (W/m^2) assuming a given generation rate

Parameters
shapeThe heat shape
zThe axial positions of the faces (m)
diamThe diameter of the fuel rods (m)
Q_totThe total heat generation rate (W)

◆ getNumberOfSubchannels()

size_t AMP::Operator::Subchannel::getNumberOfSubchannels ( std::shared_ptr< AMP::Mesh::Mesh subchannel)

Function to get the number of subchannels from the mesh.

Parameters
[in]subchannelThe subchannel mesh

◆ getSubchannelProperties()

void AMP::Operator::Subchannel::getSubchannelProperties ( std::shared_ptr< AMP::Mesh::Mesh subchannel,
const std::vector< double > &  clad_x,
const std::vector< double > &  clad_y,
const std::vector< double > &  clad_d,
std::vector< double > &  x,
std::vector< double > &  y,
std::vector< double > &  area,
std::vector< double > &  diam,
std::vector< double > &  rod_diameter,
std::vector< double > &  channel_fraction 
)

Function to get some basic properties for each subchannel based on the mesh.

This function returns some basic properties including the hydraulic diameter, subchannel area, etc from the mesh

Parameters
[in]subchannelThe subchannel mesh
[in]clad_xThe x-coordinates of the clad
[in]clad_yThe y-coordinates of the clad
[in]clad_dThe diameters of the clad
[out]xThe x-coordinates of the subchannel boundaries (Nx+1)
[out]yThe y-coordinates of the subchannel boundaries (Ny+1)
[out]areaThe flow area of the subchannels (Nx x Ny)
[out]diamThe hydraulic diameter of the subchannels defined using the wetted rod perimeter (Nx x Ny)
[out]rod_diameterThe average rod diameter for each subchannel (Nx x Ny)
[out]channel_fractionThe fraction of the rod in each subchannel (Nx x Ny)

◆ subsetForSubchannel()

std::shared_ptr< AMP::Mesh::Mesh > AMP::Operator::Subchannel::subsetForSubchannel ( std::shared_ptr< AMP::Mesh::Mesh subchannel,
size_t  i,
size_t  j 
)

Function to subset the subchannel mesh for a particular subchannel.

Parameters
[in]subchannelThe subchannel mesh
[in]iThe x-index of the subchannel of interest
[in]jThe y-index of the subchannel of interest

Variable Documentation

◆ scaleAxialMassFlowRate

constexpr double AMP::Operator::Subchannel::scaleAxialMassFlowRate
constexpr
Initial value:
=
1e-3

Definition at line 7 of file SubchannelConstants.h.

◆ scaleEnthalpy

constexpr double AMP::Operator::Subchannel::scaleEnthalpy
constexpr
Initial value:
=
1e-3

Definition at line 9 of file SubchannelConstants.h.

◆ scaleLateralMassFlowRate

constexpr double AMP::Operator::Subchannel::scaleLateralMassFlowRate
constexpr
Initial value:
=
1e-3

Definition at line 13 of file SubchannelConstants.h.

◆ scalePressure

constexpr double AMP::Operator::Subchannel::scalePressure
constexpr
Initial value:
=
1e-3

Definition at line 11 of file SubchannelConstants.h.



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:44.
Comments on this page