Action that adds SubChannel variables needs for the solve. More...

#include <SubChannelAddVariablesAction.h>

Inheritance diagram for SubChannelAddVariablesAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	SubChannelAddVariablesAction (const InputParameters &parameters)

virtual void	act () override

void	timedAct ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	haveParameter (const std::string &name) const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
void	addAuxVariable (const std::string &var_name, const std::vector< SubdomainName > &blocks)
	Add a block-restricted auxiliary variable unless the user already defined it. More...

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

void	associateWithParameter (const std::string &param_name, InputParameters &params) const

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
const MooseEnum	_fe_family
	FE family of the aux variables added by this action. More...

const MooseEnum	_fe_order
	FE order of the aux variables added by this action. More...

std::string	_registered_identifier

std::string	_specific_task_name

std::set< std::string >	_all_tasks

ActionWarehouse &	_awh

const std::string &	_current_task

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem

PerfID	_act_timer

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Detailed Description

Action that adds SubChannel variables needs for the solve.

Definition at line 19 of file SubChannelAddVariablesAction.h.

Constructor & Destructor Documentation

◆ SubChannelAddVariablesAction()

SubChannelAddVariablesAction::SubChannelAddVariablesAction ( const InputParameters & parameters )

Definition at line 29 of file SubChannelAddVariablesAction.C.

   : Action(parameters),
     _fe_family(AddAuxVariableAction::getAuxVariableFamilies()),
     _fe_order(AddAuxVariableAction::getAuxVariableOrders())
 {
 }

Member Function Documentation

◆ act()

void SubChannelAddVariablesAction::act ( )

overridevirtual

Implements Action.

Definition at line 55 of file SubChannelAddVariablesAction.C.

 {
   bool pin_mesh_exist = false;
   bool duct_mesh_exist = false;
 
   std::vector<SubdomainName> fluid_blocks;
   std::vector<SubdomainName> pin_blocks;
   std::vector<SubdomainName> duct_blocks;
 
   const auto & mesh_actions = _awh.getActions<AddMeshGeneratorAction>();
 
   for (const auto * mesh_action : mesh_actions)
   {
     if (!mesh_action->parameters().isParamValid("type"))
       continue;
 
     const auto & generator_type = mesh_action->getParam<std::string>("type");
 
     if (generator_type == "SCMQuadSubChannelMeshGenerator" ||
         generator_type == "SCMTriSubChannelMeshGenerator")
     {
       // Use the user-provided mesh generator block name
       fluid_blocks = {mesh_action->name()};
     }
 
     if (generator_type == "SCMTriPinMeshGenerator" || generator_type == "SCMQuadPinMeshGenerator")
     {
       pin_mesh_exist = true;
       // Use the user-provided mesh generator block name
       pin_blocks = {mesh_action->name()};
     }
 
     if (generator_type == "SCMTriDuctMeshGenerator" || generator_type == "SCMQuadDuctMeshGenerator")
     {
       duct_mesh_exist = true;
       // Use the user-provided mesh generator block name
       duct_blocks = {mesh_action->name()};
     }
   }
 
   // Backward-compatible fallback if no explicit subchannel mesh generator name was found
   if (fluid_blocks.empty())
     fluid_blocks = {"sub_channel"};
 
   std::vector<std::pair<std::string, std::vector<SubdomainName>>> vars_to_add;
 
   // Always-fluid variables
   vars_to_add.push_back({SubChannelApp::MASS_FLOW_RATE, fluid_blocks});
   vars_to_add.push_back({SubChannelApp::SURFACE_AREA, fluid_blocks});
   vars_to_add.push_back({SubChannelApp::SUM_CROSSFLOW, fluid_blocks});
   vars_to_add.push_back({SubChannelApp::PRESSURE, fluid_blocks});
   vars_to_add.push_back({SubChannelApp::WETTED_PERIMETER, fluid_blocks});
   vars_to_add.push_back({SubChannelApp::ENTHALPY, fluid_blocks});
   vars_to_add.push_back({SubChannelApp::TEMPERATURE, fluid_blocks});
   vars_to_add.push_back({SubChannelApp::DENSITY, fluid_blocks});
   vars_to_add.push_back({SubChannelApp::VISCOSITY, fluid_blocks});
   vars_to_add.push_back({SubChannelApp::DISPLACEMENT, fluid_blocks});
 
   // q_prime lives on pins if pins exist, otherwise on the fluid mesh
   if (pin_mesh_exist)
     vars_to_add.push_back({SubChannelApp::LINEAR_HEAT_RATE, pin_blocks});
   else
     vars_to_add.push_back({SubChannelApp::LINEAR_HEAT_RATE, fluid_blocks});
 
   // Pin-only variables
   if (pin_mesh_exist)
   {
     vars_to_add.push_back({SubChannelApp::PIN_TEMPERATURE, pin_blocks});
     vars_to_add.push_back({SubChannelApp::PIN_DIAMETER, pin_blocks});
     // HTC is a subchannel-average output stored on the fluid mesh.
     vars_to_add.push_back({SubChannelApp::HEAT_TRANSFER_COEFFICIENT, fluid_blocks});
   }
 
   // Duct-only variables
   if (duct_mesh_exist)
   {
     vars_to_add.push_back({SubChannelApp::DUCT_HEAT_FLUX, duct_blocks});
     vars_to_add.push_back({SubChannelApp::DUCT_TEMPERATURE, duct_blocks});
   }
 
   if (getParam<bool>("full_output"))
   {
     vars_to_add.push_back({SubChannelApp::PRESSURE_DROP, fluid_blocks});
     vars_to_add.push_back({SubChannelApp::FRICTION_FACTOR, fluid_blocks});
   }
 
   for (const auto & var_info : vars_to_add)
     addAuxVariable(var_info.first, var_info.second);
 }

◆ addAuxVariable()

void SubChannelAddVariablesAction::addAuxVariable	(	const std::string &	var_name,
		const std::vector< SubdomainName > &	blocks
	)

protected

Add a block-restricted auxiliary variable unless the user already defined it.

Definition at line 37 of file SubChannelAddVariablesAction.C.

Referenced by act().

 {
   const auto & aux_actions = _awh.getActions<AddAuxVariableAction>();
 
   for (const auto * aux_action : aux_actions)
     if (aux_action->name() == var_name)
       return;
 
   auto params = _factory.getValidParams("MooseVariable");
   params.set<MooseEnum>("family") = _fe_family;
   params.set<MooseEnum>("order") = _fe_order;
   params.set<std::vector<SubdomainName>>("block") = blocks;
 
   _problem->addAuxVariable("MooseVariable", var_name, params);
 }

◆ validParams()

InputParameters SubChannelAddVariablesAction::validParams ( )

static

Definition at line 21 of file SubChannelAddVariablesAction.C.

 {
   InputParameters params = Action::validParams();
   params.addClassDescription("Adds the variables associated with the subchannel problem");
   params.addParam<bool>("full_output", false, "Add optional subchannel output variables");
   return params;
 }