https://mooseframework.inl.gov
SCMPinSolutionTransfer.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "SCMPinSolutionTransfer.h"
11 #include "SubChannelMesh.h"
12 
14 registerMooseObjectRenamed("SubChannelApp",
15  PinSolutionTransfer,
16  "06/30/2025 24:00",
18 
21 {
23  params.addClassDescription(
24  "Transfers pin solution from computational mesh onto visualization mesh");
25  return params;
26 }
27 
29  : SCMSolutionTransferBase(parameters)
30 {
31 }
32 
33 Node *
34 SCMPinSolutionTransfer::getFromNode(const SubChannelMesh & from_mesh, const Point & src_node)
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 }
virtual unsigned int pinIndex(const Point &p) const =0
SCMPinSolutionTransfer(const InputParameters &parameters)
static InputParameters validParams()
virtual Node * getPinNode(unsigned int i_pin, unsigned iz) const =0
Get the pin mesh node for a given pin index and elevation index.
Base class for transfering solutions from computational mesh onto visualization mesh.
registerMooseObject("SubChannelApp", SCMPinSolutionTransfer)
Transfers subchannel solution from computational mesh onto visualization mesh.
registerMooseObjectRenamed("SubChannelApp", PinSolutionTransfer, "06/30/2025 24:00", SCMPinSolutionTransfer)
static InputParameters validParams()
virtual Node * getFromNode(const SubChannelMesh &from_mesh, const Point &src_node)
Find node on computational mesh given the visualization point.
void addClassDescription(const std::string &doc_string)
Base class for subchannel meshes.
virtual unsigned int getZIndex(const Point &point) const
Get axial index of point.