Transfers subchannel and pin solutions from a SubChannel mesh onto a visualization mesh. More...

#include <SCMSolutionTransfer.h>

Inheritance diagram for SCMSolutionTransfer:

Public Types
enum	DIRECTION

typedef DataFileName	DataFileParameterType

Public Member Functions
	SCMSolutionTransfer (const InputParameters &parameters)

virtual void	execute () override

void	initialSetup () override

void	variableIntegrityCheck (const AuxVariableName &var_name, bool is_from_multiapp) const

const std::shared_ptr< MultiApp >	getMultiApp () const

const std::shared_ptr< MultiApp >	getFromMultiApp () const

const std::shared_ptr< MultiApp >	getToMultiApp () const

std::string	getFromName () const

std::string	getToName () const

bool	hasFromMultiApp () const

bool	hasToMultiApp () const

virtual void	getAppInfo ()

const MultiMooseEnum &	directions ()

void	setCurrentDirection (const int direction)

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

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	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

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

PerfGraph &	perfGraph ()

MooseEnum	direction ()

MooseEnum	direction ()

MooseEnum	currentDirection ()

MooseEnum	currentDirection ()

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)

static void	addSkipCoordCollapsingParam (InputParameters &params)

static libMesh::System *	find_sys (libMesh::EquationSystems &es, const std::string &var_name)

static std::string	possibleDirections ()

Public Attributes
	TO_MULTIAPP

	FROM_MULTIAPP

	BETWEEN_MULTIAPP

	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const libMesh::Number	OutOfMeshValue

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

Protected Member Functions
void	transferToMultiApps ()

void	transferVarsToApp (unsigned int app_idx)

void	transferNodalVars (unsigned int app_idx)

void	validateVariableLocations (const SubChannelMesh &from_mesh, FEProblemBase &to_problem)

Node *	getFromNode (const SubChannelMesh &from_mesh, const Point &src_node)

std::vector< unsigned int >	getFromsPerProc ()

libMesh::NumericVector< Real > &	getTransferVector (unsigned int i_local, std::string var_name)

unsigned int	getGlobalSourceAppIndex (unsigned int i_from) const

unsigned int	getGlobalTargetAppIndex (unsigned int i_to) const

unsigned int	getLocalSourceAppIndex (unsigned int i_from) const

virtual void	checkSiblingsTransferSupported () const

void	checkParentAppUserObjectExecuteOn (const std::string &object_name) const

void	errorIfObjectExecutesOnTransferInSourceApp (const std::string &object_name) const

Point	getPointInTargetAppFrame (const Point &p, unsigned int local_i_to, const std::string &phase) const

Point	getPointInSourceAppFrame (const Point &p, unsigned int local_i_from, const std::string &phase) const

void	checkMultiAppExecuteOn ()

void	checkVariable (const FEProblemBase &fe_problem, const VariableName &var_name, const std::string &param_name="") const

void	extendBoundingBoxes (const Real factor, std::vector< libMesh::BoundingBox > &bboxes) const

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

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

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

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

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (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

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes ()

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes (BoundaryID boundary_id)

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes ()

std::vector< libMesh::BoundingBox >	getFromBoundingBoxes (BoundaryID boundary_id)

Static Protected Member Functions
static void	addUserObjectExecutionCheckParam (InputParameters &params)

static void	addBBoxFactorParam (InputParameters &params)

static void	transformBoundingBox (libMesh::BoundingBox &box, const MultiAppCoordTransform &transform)

Protected Attributes
const std::vector< AuxVariableName > &	_var_names
	Variable names to transfer.

const bool	_pin_transfer
	Whether pin fields should be transferred instead of subchannel fields.

std::shared_ptr< MultiApp >	_multi_app

std::vector< FEProblemBase * >	_to_problems

std::vector< FEProblemBase * >	_from_problems

std::vector< libMesh::EquationSystems * >	_to_es

std::vector< libMesh::EquationSystems * >	_from_es

std::vector< MooseMesh * >	_to_meshes

std::vector< MooseMesh * >	_from_meshes

std::vector< Point >	_to_positions

std::vector< Point >	_from_positions

std::vector< std::unique_ptr< MultiAppCoordTransform > >	_to_transforms

std::vector< std::unique_ptr< MultiAppCoordTransform > >	_from_transforms

const bool	_skip_coordinate_collapsing

bool	_displaced_source_mesh

bool	_displaced_target_mesh

Real	_bbox_factor

std::vector< unsigned int >	_to_local2global_map

std::vector< unsigned int >	_from_local2global_map

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

THREAD_ID	_tid

MultiMooseEnum	_directions

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

MooseApp &	_pg_moose_app

const std::string	_prefix

MooseEnum	_direction

MooseEnum	_current_direction

const Parallel::Communicator &	_communicator

Private Member Functions
virtual bool	usesMooseAppCoordTransform () const

Point	mapBackWithoutCollapsing (MultiAppCoordTransform &transform, const Point &p, const std::string &phase) const

void	getFromMultiAppInfo ()

void	getToMultiAppInfo ()

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)

RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
std::shared_ptr< MultiApp >	_from_multi_app

std::shared_ptr< MultiApp >	_to_multi_app

std::unique_ptr< MooseAppCoordTransform >	_from_moose_app_transform

std::unique_ptr< MooseAppCoordTransform >	_to_moose_app_transform

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

ExecFlagEnum	_empty_execute_enum

const RestartableDataMapName	_metaname

std::string	_restartable_name

Detailed Description

Transfers subchannel and pin solutions from a SubChannel mesh onto a visualization mesh.

Definition at line 20 of file SCMSolutionTransfer.h.

Constructor & Destructor Documentation

◆ SCMSolutionTransfer()

SCMSolutionTransfer::SCMSolutionTransfer ( const InputParameters & parameters )

Definition at line 55 of file SCMSolutionTransfer.C.

  : MultiAppTransfer(parameters),
    _var_names(getParam<std::vector<AuxVariableName>>("variable")),
    _pin_transfer(
        getParam<MooseEnum>("transfer_type") == "pin" ||
        (!parameters.isParamSetByUser("transfer_type") && isDeprecatedPinTransferType(parameters)))
{
  if (_directions.contains(Transfer::FROM_MULTIAPP))
    paramError("from_multiapp", "This transfer works only into multi-app.");
}

Member Function Documentation

◆ execute()

void SCMSolutionTransfer::execute ( )

overridevirtual

Implements MultiAppTransfer.

Definition at line 94 of file SCMSolutionTransfer.C.

{
  TIME_SECTION(
      "MultiAppDetailedSolutionBaseTransfer::execute()", 5, "Transferring subchannel solutions");
  getAppInfo();
 
  switch (_current_direction)
  {
    case TO_MULTIAPP:
    case BETWEEN_MULTIAPP:
      transferToMultiApps();
      break;
 
    default:
      break;
  }
}

◆ getFromNode()

Node * SCMSolutionTransfer::getFromNode	(	const SubChannelMesh &	from_mesh,
		const Point &	src_node
	)

protected

Definition at line 233 of file SCMSolutionTransfer.C.

{
  unsigned int sch_idx =
      _pin_transfer ? from_mesh.pinIndex(src_node) : from_mesh.channelIndex(src_node);
  unsigned iz = from_mesh.getZIndex(src_node);
  return _pin_transfer ? from_mesh.getPinNode(sch_idx, iz) : from_mesh.getChannelNode(sch_idx, iz);
}

Referenced by transferNodalVars().

◆ initialSetup()

void SCMSolutionTransfer::initialSetup ( )

overridevirtual

Reimplemented from MultiAppTransfer.

Definition at line 67 of file SCMSolutionTransfer.C.

{
  MultiAppTransfer::initialSetup();
  for (std::size_t var_index = 0; var_index < _var_names.size(); ++var_index)
  {
    if (_to_problems.empty())
      continue;
 
    MooseVariableFieldBase & from_var = _subproblem.getVariable(
        0, _var_names[var_index], Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
    const auto & fe_type = from_var.feType();
 
    if (fe_type.family != LAGRANGE || fe_type.order != FIRST)
      paramError("variable",
                 "This transfer requires a first order Lagrange variable for the source variable");
 
    MooseVariableFieldBase & to_var = _to_problems[0]->getVariable(
        0, _var_names[var_index], Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
    const auto & fe_type_target = to_var.feType();
 
    if (fe_type_target.family != LAGRANGE || fe_type_target.order != FIRST)
      paramError("variable",
                 "This transfer requires a first order Lagrange variable for the source variable");
  }
}

◆ transferNodalVars()

void SCMSolutionTransfer::transferNodalVars ( unsigned int app_idx )

protected

Definition at line 135 of file SCMSolutionTransfer.C.

{
  Moose::ScopedCommSwapper swapper(getToMultiApp()->comm());
 
  FEProblemBase & to_problem = getToMultiApp()->appProblemBase(app_idx);
  MooseMesh * mesh = NULL;
  if (_displaced_target_mesh && to_problem.getDisplacedProblem())
    mesh = &to_problem.getDisplacedProblem()->mesh();
  else
    mesh = &to_problem.mesh();
 
  const SubChannelMesh & from_mesh = dynamic_cast<SubChannelMesh &>(*_from_meshes[0]);
  FEProblemBase & from_problem = *_from_problems[0];
  validateVariableLocations(from_mesh, to_problem);
 
  for (auto & node : mesh->getMesh().local_node_ptr_range())
  {
    if (processor_id() != 0)
      continue;
    Node * from_node = getFromNode(from_mesh, *node);
 
    for (auto & var_name : _var_names)
    {
      System * to_sys = find_sys(to_problem.es(), var_name);
      unsigned int to_sys_num = to_sys->number();
      unsigned int to_var_num = to_sys->variable_number(var_name);
 
      if (node->n_dofs(to_sys_num, to_var_num) > 0)
      {
        System * from_sys = find_sys(from_problem.es(), var_name);
        unsigned int from_sys_num = from_sys->number();
        unsigned int from_var_num = from_sys->variable_number(var_name);
 
        // Return to parent app MPI communicator to get solution dof
        swapper.forceSwap();
        NumericVector<Real> * from_solution = from_sys->solution.get();
        dof_id_type from_dof = from_node->dof_number(from_sys_num, from_var_num, 0);
        Real from_value = (*from_solution)(from_dof);
        swapper.forceSwap();
 
        NumericVector<Real> & to_solution = getToMultiApp()->appTransferVector(app_idx, var_name);
        dof_id_type to_dof = node->dof_number(to_sys_num, to_var_num, 0);
        to_solution.set(to_dof, from_value);
      }
    }
  }
 
  for (auto & var_name : _var_names)
  {
    getToMultiApp()->appTransferVector(app_idx, var_name).close();
    find_sys(to_problem.es(), var_name)->update();
  }
}

Referenced by transferVarsToApp().

◆ transferToMultiApps()

void SCMSolutionTransfer::transferToMultiApps ( )

protected

Definition at line 113 of file SCMSolutionTransfer.C.

{
  mooseAssert(_from_meshes.size() == 1, "Only one source mesh can be active in this transfer.");
  auto * from_mesh = dynamic_cast<SubChannelMesh *>(_from_meshes[0]);
  if (from_mesh == nullptr)
    mooseError("This transfer works only with SubChannelMesh classes.");
  if (_pin_transfer && !from_mesh->pinMeshExist())
    mooseError(
        "This transfer was configured for pin variables, but the source mesh has no pin mesh.");
 
  for (unsigned int i = 0; i < getToMultiApp()->numGlobalApps(); i++)
    if (getToMultiApp()->hasLocalApp(i))
      transferVarsToApp(i);
}

Referenced by execute().

◆ transferVarsToApp()

void SCMSolutionTransfer::transferVarsToApp ( unsigned int app_idx )

protected

Definition at line 129 of file SCMSolutionTransfer.C.

{
  transferNodalVars(app_idx);
}

Referenced by transferToMultiApps().

◆ validateVariableLocations()

void SCMSolutionTransfer::validateVariableLocations	(	const SubChannelMesh &	from_mesh,
		FEProblemBase &	to_problem
	)

protected

Definition at line 190 of file SCMSolutionTransfer.C.

{
  if (processor_id() != 0)
    return;
 
  Node * from_node = _pin_transfer ? from_mesh.getPinNode(0, 0) : from_mesh.getChannelNode(0, 0);
  mooseAssert(from_node, "The representative source node must be non-null.");
 
  FEProblemBase & from_problem = *_from_problems[0];
  const auto transfer_type = _pin_transfer ? "pin" : "subchannel";
  const auto other_transfer_type = _pin_transfer ? "subchannel" : "pin";
  const auto expected_block = _pin_transfer ? "fuel_pins" : "subchannel";
  const auto source_block_id = from_mesh.getSubdomainID(expected_block);
  const auto target_block_id = to_problem.mesh().getSubdomainID(expected_block);
 
  for (const auto & var_name : _var_names)
  {
    MooseVariableFieldBase & from_var = from_problem.getVariable(
        0, var_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
    MooseVariableFieldBase & to_var = to_problem.getVariable(
        0, var_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
    System * from_sys = find_sys(from_problem.es(), var_name);
    const auto from_sys_num = from_sys->number();
    const auto from_var_num = from_sys->variable_number(var_name);
 
    if (!from_var.activeOnSubdomain(source_block_id) ||
        !to_var.activeOnSubdomain(target_block_id) ||
        from_node->n_dofs(from_sys_num, from_var_num) == 0)
      paramError("variable",
                 "The variable '",
                 var_name,
                 "' does not have DOFs on ",
                 transfer_type,
                 " nodes. Use a separate SCMSolutionTransfer with transfer_type = '",
                 other_transfer_type,
                 "' for variables centered on ",
                 other_transfer_type,
                 " nodes.");
  }
}

Referenced by transferNodalVars().

◆ validParams()

InputParameters SCMSolutionTransfer::validParams ( )

static

Definition at line 41 of file SCMSolutionTransfer.C.

{
  InputParameters params = MultiAppTransfer::validParams();
  params.addRequiredParam<std::vector<AuxVariableName>>("variable",
                                                        "The auxiliary variables to transfer.");
  MooseEnum transfer_type("subchannel pin", "subchannel");
  params.addParam<MooseEnum>("transfer_type",
                             transfer_type,
                             "Whether to transfer subchannel-centered or pin-centered fields.");
  params.addClassDescription(
      "Transfers subchannel or pin solutions from a SubChannel mesh onto a visualization mesh.");
  return params;
}

Member Data Documentation

◆ _pin_transfer

const bool SCMSolutionTransfer::_pin_transfer

protected

Whether pin fields should be transferred instead of subchannel fields.

Definition at line 39 of file SCMSolutionTransfer.h.

Referenced by getFromNode(), transferToMultiApps(), and validateVariableLocations().

◆ _var_names

const std::vector<AuxVariableName>& SCMSolutionTransfer::_var_names

protected

Variable names to transfer.

Definition at line 36 of file SCMSolutionTransfer.h.

Referenced by initialSetup(), transferNodalVars(), and validateVariableLocations().

The documentation for this class was generated from the following files:

subchannel/include/transfers/SCMSolutionTransfer.h
subchannel/src/transfers/SCMSolutionTransfer.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCMSolutionTransfer()

Member Function Documentation

◆ execute()

◆ getFromNode()

◆ initialSetup()

◆ transferNodalVars()

◆ transferToMultiApps()

◆ transferVarsToApp()

◆ validateVariableLocations()

◆ validParams()

Member Data Documentation

◆ _pin_transfer

◆ _var_names