www.mooseframework.org
stochastic_tools
include
transfers
StochasticToolsTransfer.h
Go to the documentation of this file.
1
//* This file is part of the MOOSE framework
2
//* https://www.mooseframework.org
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
class
StochasticToolsTransfer
;
17
template
<>
18
InputParameters
validParams<StochasticToolsTransfer>
();
19
24
class
StochasticToolsTransfer
:
public
MultiAppTransfer, SamplerInterface
25
{
26
public
:
27
static
InputParameters
validParams
();
28
29
StochasticToolsTransfer
(
const
InputParameters & parameters);
30
32
35
virtual
void
initializeFromMultiapp
();
36
virtual
void
executeFromMultiapp
();
37
virtual
void
finalizeFromMultiapp
();
39
41
44
virtual
void
initializeToMultiapp
();
45
virtual
void
executeToMultiapp
();
46
virtual
void
finalizeToMultiapp
();
48
54
void
setGlobalMultiAppIndex
(dof_id_type index) {
_global_index
= index; }
55
56
protected
:
58
dof_id_type
_global_index
= 0;
59
61
Sampler *
_sampler_ptr
;
62
};
StochasticToolsTransfer
The class creates an additional API to allow Transfers to work when running the StochasticTools<FullS...
Definition:
StochasticToolsTransfer.h:24
StochasticToolsTransfer::StochasticToolsTransfer
StochasticToolsTransfer(const InputParameters ¶meters)
Definition:
StochasticToolsTransfer.C:26
StochasticToolsTransfer::finalizeFromMultiapp
virtual void finalizeFromMultiapp()
Definition:
StochasticToolsTransfer.C:117
validParams< StochasticToolsTransfer >
InputParameters validParams< StochasticToolsTransfer >()
StochasticToolsTransfer::_sampler_ptr
Sampler * _sampler_ptr
Pointer to the Sampler object used by the SamplerTransientMultiApp or SamplerFullSolveMultiApp.
Definition:
StochasticToolsTransfer.h:61
StochasticToolsTransfer::setGlobalMultiAppIndex
void setGlobalMultiAppIndex(dof_id_type index)
Method for keeping track of the global MultiApp index when running in batch mode.
Definition:
StochasticToolsTransfer.h:54
StochasticToolsTransfer::validParams
static InputParameters validParams()
Definition:
StochasticToolsTransfer.C:18
StochasticToolsTransfer::executeFromMultiapp
virtual void executeFromMultiapp()
Definition:
StochasticToolsTransfer.C:112
StochasticToolsTransfer::finalizeToMultiapp
virtual void finalizeToMultiapp()
Definition:
StochasticToolsTransfer.C:132
StochasticToolsTransfer::executeToMultiapp
virtual void executeToMultiapp()
Definition:
StochasticToolsTransfer.C:127
StochasticToolsTransfer::initializeToMultiapp
virtual void initializeToMultiapp()
Methods for transferring data to sub-applications to the master application.
Definition:
StochasticToolsTransfer.C:122
StochasticToolsTransfer::initializeFromMultiapp
virtual void initializeFromMultiapp()
Methods for transferring data from sub-applications to the master application.
Definition:
StochasticToolsTransfer.C:107
StochasticToolsTransfer::_global_index
dof_id_type _global_index
Index for tracking the global index when using batch mode operation.
Definition:
StochasticToolsTransfer.h:58
Generated on Sat Jan 25 2020 12:04:43 for www.mooseframework.org by
1.8.16