https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
SCMPinSolutionTransfer Class Reference

Transfers subchannel solution from computational mesh onto visualization mesh. More...

#include <SCMPinSolutionTransfer.h>

Inheritance diagram for SCMPinSolutionTransfer:
[legend]

Public Types

enum  DIRECTION
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 SCMPinSolutionTransfer (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 (IsKokkosObjectKey &&) 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 mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) 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)
 
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

virtual Node * getFromNode (const SubChannelMesh &from_mesh, const Point &src_node)
 Find node on computational mesh given the visualization point. More...
 
void transferToMultiApps ()
 Do the transfer into the sub-app. More...
 
void transferVarsToApp (unsigned int app_idx)
 Transfer variables into the sub-app. More...
 
void transferNodalVars (unsigned int app_idx)
 
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
 
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. More...
 
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
 

Detailed Description

Transfers subchannel solution from computational mesh onto visualization mesh.

Definition at line 17 of file SCMPinSolutionTransfer.h.

Constructor & Destructor Documentation

◆ SCMPinSolutionTransfer()

SCMPinSolutionTransfer::SCMPinSolutionTransfer ( const InputParameters &  parameters)

Definition at line 28 of file SCMPinSolutionTransfer.C.

29  : SCMSolutionTransferBase(parameters)
30 {
31 }
MultiAppTransfer::parameters
const InputParameters & parameters() const
SCMSolutionTransferBase::SCMSolutionTransferBase
SCMSolutionTransferBase(const InputParameters &parameters)
Definition: SCMSolutionTransferBase.C:25

Member Function Documentation

◆ execute()

void SCMSolutionTransferBase::execute ( )
overridevirtualinherited

Implements MultiAppTransfer.

Definition at line 66 of file SCMSolutionTransferBase.C.

67 {
68  TIME_SECTION(
69  "MultiAppDetailedSolutionBaseTransfer::execute()", 5, "Transferring subchannel solutions");
70  getAppInfo();
71 
72  switch (_current_direction)
73  {
74  case TO_MULTIAPP:
75  transferToMultiApps();
76  break;
77 
78  default:
79  break;
80  }
81 }
MultiAppTransfer::_current_direction
MooseEnum _current_direction
SCMSolutionTransferBase::transferToMultiApps
void transferToMultiApps()
Do the transfer into the sub-app.
Definition: SCMSolutionTransferBase.C:84
MultiAppTransfer::getAppInfo
virtual void getAppInfo()

◆ getFromNode()

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

Find node on computational mesh given the visualization point.

Returns
Node from the computational mesh
Parameters
from_meshComputational mesh
src_nodeNode from the visualization

Implements SCMSolutionTransferBase.

Definition at line 34 of file SCMPinSolutionTransfer.C.

35 {
36  unsigned int pin_idx = from_mesh.pinIndex(src_node);
37  unsigned iz = from_mesh.getZIndex(src_node);
38  return from_mesh.getPinNode(pin_idx, iz);
39 }
SubChannelMesh::pinIndex
virtual unsigned int pinIndex(const Point &p) const =0
SubChannelMesh::getPinNode
virtual Node * getPinNode(unsigned int i_pin, unsigned iz) const =0
Get the pin mesh node for a given pin index and elevation index.
SubChannelMesh::getZIndex
virtual unsigned int getZIndex(const Point &point) const
Get axial index of point.
Definition: SubChannelMesh.C:52

◆ initialSetup()

void SCMSolutionTransferBase::initialSetup ( )
overridevirtualinherited

Reimplemented from MultiAppTransfer.

Definition at line 33 of file SCMSolutionTransferBase.C.

34 {
35  MultiAppTransfer::initialSetup();
36  for (std::size_t var_index = 0; var_index < _var_names.size(); ++var_index)
37  {
38  // No local app, we cannot examine the target variable
39  if (_to_problems.empty())
40  continue;
41 
42  // Check source variable on regular subchannel problem
43  MooseVariableFieldBase & from_var = _subproblem.getVariable(
44  0, _var_names[var_index], Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
45  System & from_sys = from_var.sys().system();
46  const auto & fe_type = from_sys.variable_type(from_var.number());
47 
48  if (fe_type.family != LAGRANGE || fe_type.order != FIRST)
49  paramError("variable",
50  "This transfer requires a first order Lagrange variable for the source variable");
51 
52  // Check target variable in visualization mesh
53  MooseVariableFieldBase & to_var = _to_problems[0]->getVariable(
54  0, _var_names[var_index], Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
55 
56  System & to_sys = to_var.sys().system();
57  const auto & fe_type_target = to_sys.variable_type(to_var.number());
58 
59  if (fe_type_target.family != LAGRANGE || fe_type_target.order != FIRST)
60  paramError("variable",
61  "This transfer requires a first order Lagrange variable for the source variable");
62  }
63 }
MultiAppTransfer::paramError
void paramError(const std::string &param, Args... args) const
MooseVariableFieldBase::number
unsigned int number() const
SystemBase::system
virtual libMesh::System & system()=0
SCMSolutionTransferBase::_var_names
const std::vector< AuxVariableName > & _var_names
Variable names to transfer.
Definition: SCMSolutionTransferBase.h:52
MultiAppTransfer::_to_problems
std::vector< FEProblemBase *> _to_problems
MultiAppTransfer::initialSetup
void initialSetup() override
SubProblem::getVariable
virtual const MooseVariableFieldBase & getVariable(const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) const=0
MultiAppTransfer::_subproblem
SubProblem & _subproblem
libMesh::System::variable_type
const FEType & variable_type(const unsigned int i) const
MooseVariableFieldBase::sys
SystemBase & sys()

◆ transferNodalVars()

void SCMSolutionTransferBase::transferNodalVars ( unsigned int  app_idx)
protectedinherited

Definition at line 102 of file SCMSolutionTransferBase.C.

Referenced by SCMSolutionTransferBase::transferVarsToApp().

103 {
104  Moose::ScopedCommSwapper swapper(getToMultiApp()->comm());
105 
106  FEProblemBase & to_problem = getToMultiApp()->appProblemBase(app_idx);
107  MooseMesh * mesh = NULL;
108  if (_displaced_target_mesh && to_problem.getDisplacedProblem())
109  mesh = &to_problem.getDisplacedProblem()->mesh();
110  else
111  mesh = &to_problem.mesh();
112 
113  const SubChannelMesh & from_mesh = dynamic_cast<SubChannelMesh &>(*_from_meshes[0]);
114  FEProblemBase & from_problem = *_from_problems[0];
115 
116  for (auto & node : mesh->getMesh().local_node_ptr_range())
117  {
118  // No local data to send
119  if (processor_id() != 0)
120  continue;
121  Node * from_node = getFromNode(from_mesh, *node);
122 
123  for (auto & var_name : _var_names)
124  {
125  System * to_sys = find_sys(to_problem.es(), var_name);
126  unsigned int to_sys_num = to_sys->number();
127  unsigned int to_var_num = to_sys->variable_number(var_name);
128 
129  if (node->n_dofs(to_sys_num, to_var_num) > 0)
130  {
131  System * from_sys = find_sys(from_problem.es(), var_name);
132  unsigned int from_sys_num = from_sys->number();
133  unsigned int from_var_num = from_sys->variable_number(var_name);
134 
135  swapper.forceSwap();
136  NumericVector<Real> * from_solution = from_sys->solution.get();
137  dof_id_type from_dof = from_node->dof_number(from_sys_num, from_var_num, 0);
138  Real from_value = (*from_solution)(from_dof);
139  swapper.forceSwap();
140 
141  NumericVector<Real> & to_solution = getToMultiApp()->appTransferVector(app_idx, var_name);
142  dof_id_type to_dof = node->dof_number(to_sys_num, to_var_num, 0);
143  to_solution.set(to_dof, from_value);
144  }
145  }
146  }
147 
148  for (auto & var_name : _var_names)
149  {
150  getToMultiApp()->appTransferVector(app_idx, var_name).close();
151  find_sys(to_problem.es(), var_name)->update();
152  }
153 }
MooseMesh
SCMSolutionTransferBase::_var_names
const std::vector< AuxVariableName > & _var_names
Variable names to transfer.
Definition: SCMSolutionTransferBase.h:52
mesh
MeshBase & mesh
libMesh::ParallelObject::comm
const Parallel::Communicator & comm() const
MultiAppTransfer::getToMultiApp
const std::shared_ptr< MultiApp > getToMultiApp() const
MultiAppTransfer::_displaced_target_mesh
bool _displaced_target_mesh
libMesh::System::number
unsigned int number() const
MultiAppTransfer::_from_meshes
std::vector< MooseMesh *> _from_meshes
FEProblemBase::es
virtual libMesh::EquationSystems & es() override
MultiAppTransfer::find_sys
static libMesh::System * find_sys(libMesh::EquationSystems &es, const std::string &var_name)
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
FEProblemBase::getDisplacedProblem
virtual std::shared_ptr< const DisplacedProblem > getDisplacedProblem() const
FEProblemBase::mesh
virtual MooseMesh & mesh() override
SubChannelMesh
Base class for subchannel meshes.
Definition: SubChannelMesh.h:19
libMesh::ParallelObject::processor_id
processor_id_type processor_id() const
SCMSolutionTransferBase::getFromNode
virtual Node * getFromNode(const SubChannelMesh &from_mesh, const Point &src_node)=0
Find node on computational mesh given the visualization point.
MultiAppTransfer::_from_problems
std::vector< FEProblemBase *> _from_problems
dof_id_type
uint8_t dof_id_type

◆ transferToMultiApps()

void SCMSolutionTransferBase::transferToMultiApps ( )
protectedinherited

Do the transfer into the sub-app.

Definition at line 84 of file SCMSolutionTransferBase.C.

Referenced by SCMSolutionTransferBase::execute().

85 {
86  mooseAssert(_from_meshes.size() == 1, "Only one source mesh can be active in this transfer.");
87  if (dynamic_cast<SubChannelMesh *>(_from_meshes[0]) == nullptr)
88  mooseError("This transfer works only with SubChannelMesh classes.");
89 
90  for (unsigned int i = 0; i < getToMultiApp()->numGlobalApps(); i++)
91  if (getToMultiApp()->hasLocalApp(i))
92  transferVarsToApp(i);
93 }
MultiAppTransfer::getToMultiApp
const std::shared_ptr< MultiApp > getToMultiApp() const
MultiAppTransfer::_from_meshes
std::vector< MooseMesh *> _from_meshes
MultiAppTransfer::mooseError
void mooseError(Args &&... args) const
SCMSolutionTransferBase::transferVarsToApp
void transferVarsToApp(unsigned int app_idx)
Transfer variables into the sub-app.
Definition: SCMSolutionTransferBase.C:96

◆ transferVarsToApp()

void SCMSolutionTransferBase::transferVarsToApp ( unsigned int  app_idx)
protectedinherited

Transfer variables into the sub-app.

Parameters
app_idxMulti-app index

Definition at line 96 of file SCMSolutionTransferBase.C.

Referenced by SCMSolutionTransferBase::transferToMultiApps().

97 {
98  transferNodalVars(app_idx);
99 }
SCMSolutionTransferBase::transferNodalVars
void transferNodalVars(unsigned int app_idx)
Definition: SCMSolutionTransferBase.C:102

◆ validParams()

InputParameters SCMPinSolutionTransfer::validParams ( )
static

Definition at line 20 of file SCMPinSolutionTransfer.C.

21 {
22  InputParameters params = SCMSolutionTransferBase::validParams();
23  params.addClassDescription(
24  "Transfers pin solution from computational mesh onto visualization mesh");
25  return params;
26 }
SCMSolutionTransferBase::validParams
static InputParameters validParams()
Definition: SCMSolutionTransferBase.C:17
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _var_names

const std::vector<AuxVariableName>& SCMSolutionTransferBase::_var_names
protectedinherited

Variable names to transfer.

Definition at line 52 of file SCMSolutionTransferBase.h.

Referenced by SCMSolutionTransferBase::initialSetup(), and SCMSolutionTransferBase::transferNodalVars().

The documentation for this class was generated from the following files:
Generated on Tue Nov 4 2025 20:26:16 for https://mooseframework.inl.gov by   doxygen 1.8.14