https://mooseframework.inl.gov
stochastic_tools
include
transfers
StochasticToolsTransfer.h
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
#pragma once
10
11
// MOOSE includes
12
#include "
MultiAppTransfer.h
"
13
#include "
SamplerInterface.h
"
14
15
class
Sampler
;
16
21
class
StochasticToolsTransfer
:
public
MultiAppTransfer
,
SamplerInterface
22
{
23
public
:
24
static
InputParameters
validParams
();
25
26
StochasticToolsTransfer
(
const
InputParameters
&
parameters
);
27
29
32
virtual
void
initializeFromMultiapp
();
33
virtual
void
executeFromMultiapp
();
34
virtual
void
finalizeFromMultiapp
();
36
38
41
virtual
void
initializeToMultiapp
();
42
virtual
void
executeToMultiapp
();
43
virtual
void
finalizeToMultiapp
();
45
51
void
setGlobalMultiAppIndex
(
dof_id_type
index) {
_app_index
= index; }
52
58
void
setGlobalRowIndex
(
dof_id_type
row) {
_global_index
= row; }
59
65
void
setCurrentRow
(
const
std::vector<Real> & row) {
_row_data
= row; }
66
67
protected
:
69
dof_id_type
_app_index
= 0;
71
dof_id_type
_global_index
= 0;
73
std::vector<Real>
_row_data
;
74
76
Sampler
*
_sampler_ptr
;
77
};
StochasticToolsTransfer::_global_index
dof_id_type _global_index
Index for tracking the row index when using batch mode operation.
Definition:
StochasticToolsTransfer.h:71
StochasticToolsTransfer::_sampler_ptr
Sampler * _sampler_ptr
Pointer to the Sampler object used by the SamplerTransientMultiApp or SamplerFullSolveMultiApp.
Definition:
StochasticToolsTransfer.h:76
StochasticToolsTransfer::initializeFromMultiapp
virtual void initializeFromMultiapp()
Methods for transferring data from sub-applications to the master application.
Definition:
StochasticToolsTransfer.C:111
Sampler
StochasticToolsTransfer::setCurrentRow
void setCurrentRow(const std::vector< Real > &row)
Method for keeping track of the row data when running in batch mode.
Definition:
StochasticToolsTransfer.h:65
SamplerInterface
StochasticToolsTransfer
The class creates an additional API to allow Transfers to work when running the StochasticTools<FullS...
Definition:
StochasticToolsTransfer.h:21
MultiAppTransfer.h
InputParameters
StochasticToolsTransfer::setGlobalMultiAppIndex
void setGlobalMultiAppIndex(dof_id_type index)
Method for setting the app index when running in batch mode.
Definition:
StochasticToolsTransfer.h:51
SamplerInterface.h
StochasticToolsTransfer::_app_index
dof_id_type _app_index
Index for the sub-app that the batch-mode multiapp is working on.
Definition:
StochasticToolsTransfer.h:69
StochasticToolsTransfer::validParams
static InputParameters validParams()
Definition:
StochasticToolsTransfer.C:16
StochasticToolsTransfer::finalizeToMultiapp
virtual void finalizeToMultiapp()
Definition:
StochasticToolsTransfer.C:136
MultiAppTransfer
MultiAppTransfer::parameters
const InputParameters & parameters() const
StochasticToolsTransfer::setGlobalRowIndex
void setGlobalRowIndex(dof_id_type row)
Method for keeping track of the global row index when running in batch mode.
Definition:
StochasticToolsTransfer.h:58
StochasticToolsTransfer::executeFromMultiapp
virtual void executeFromMultiapp()
Definition:
StochasticToolsTransfer.C:116
StochasticToolsTransfer::_row_data
std::vector< Real > _row_data
The current row of data (comes from multiapp)
Definition:
StochasticToolsTransfer.h:73
StochasticToolsTransfer::StochasticToolsTransfer
StochasticToolsTransfer(const InputParameters ¶meters)
Definition:
StochasticToolsTransfer.C:24
StochasticToolsTransfer::executeToMultiapp
virtual void executeToMultiapp()
Definition:
StochasticToolsTransfer.C:131
StochasticToolsTransfer::finalizeFromMultiapp
virtual void finalizeFromMultiapp()
Definition:
StochasticToolsTransfer.C:121
StochasticToolsTransfer::initializeToMultiapp
virtual void initializeToMultiapp()
Methods for transferring data to sub-applications to the master application.
Definition:
StochasticToolsTransfer.C:126
dof_id_type
uint8_t dof_id_type
Generated on Fri Jul 18 2025 11:57:28 for https://mooseframework.inl.gov by
1.8.14