PiecewiseFunctionTransfer

Description

A simple transfer that moves the data of a PiecewiseLinear in the master to or from another PiecewiseLinear function in the sub application. Note that the function is transferred at the second time step (time step 1) since the multiapps are initialized at the first time step.

Example Input File Syntax

[Mesh<<<{"href": "../../syntax/Mesh/index.html"}>>>]
  type = GeneratedMesh
  dim = 1
[]

[Variables<<<{"href": "../../syntax/Variables/index.html"}>>>]
  [./u]
  [../]
[]

[Functions<<<{"href": "../../syntax/Functions/index.html"}>>>]
  [./func]
    type = PiecewiseLinear<<<{"description": "Linearly interpolates between pairs of x-y data", "href": "../functions/PiecewiseLinear.html"}>>>
    x<<<{"description": "The abscissa values"}>>> = '0 1'
    y<<<{"description": "The ordinate values"}>>> = '777 888'
  [../]
[]

[MultiApps<<<{"href": "../../syntax/MultiApps/index.html"}>>>]
  [./sub]
    type = TransientMultiApp<<<{"description": "MultiApp for performing coupled simulations with the parent and sub-application both progressing in time.", "href": "../multiapps/TransientMultiApp.html"}>>>
    positions<<<{"description": "The positions of the App locations.  Each set of 3 values will represent a Point.  This and 'positions_file' cannot be both supplied. If this and 'positions_file'/'_objects' are not supplied, a single position (0,0,0) will be used"}>>> = '0 0 0'
    input_files<<<{"description": "The input file for each App.  If this parameter only contains one input file it will be used for all of the Apps.  When using 'positions_from_file' it is also admissable to provide one input_file per file."}>>> = 'sub.i'
    execute_on<<<{"description": "The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html."}>>> = 'TIMESTEP_BEGIN'
  [../]
[]

[Transfers<<<{"href": "../../syntax/Transfers/index.html"}>>>]
  [./transfer]
    type = PiecewiseFunctionTransfer<<<{"description": "Transfers from one Piecewise function to another.", "href": "PiecewiseFunctionTransfer.html"}>>>
    to_multi_app<<<{"description": "The name of the MultiApp to transfer the data to"}>>> = sub
    to_function<<<{"description": "The name of the function being transferred into."}>>> = func
    from_function<<<{"description": "The name of the function being transferred out of."}>>> = func
  [../]
[]

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [./func]
    type = FunctionValuePostprocessor<<<{"description": "Computes the value of a supplied function at a single point (scalable)", "href": "../postprocessors/FunctionValuePostprocessor.html"}>>>
    function<<<{"description": "The function which supplies the postprocessor value."}>>> = func
    execute_on<<<{"description": "The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html."}>>> = 'INITIAL TIMESTEP_END'
  [../]
[]

[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
  type = FEProblem
  solve = false
  kernel_coverage_check = false
[]

[Executioner<<<{"href": "../../syntax/Executioner/index.html"}>>>]
  type = Transient
  num_steps = 2
  dt = 0.5
[]

[Outputs<<<{"href": "../../syntax/Mastodon/Outputs/index.html"}>>>]
  csv<<<{"description": "Output the scalar variable and postprocessors to a *.csv file using the default CSV output."}>>> = true
[]

Input Parameters

from_functionThe name of the function being transferred out of.
C++ Type:std::string
Controllable:No
Description:The name of the function being transferred out of.
to_functionThe name of the function being transferred into.
C++ Type:std::string
Controllable:No
Description:The name of the function being transferred into.

Required Parameters

check_multiapp_execute_onTrueWhen false the check between the multiapp and transfer execute on flags is not performed.
Default:True
C++ Type:bool
Controllable:No
Description:When false the check between the multiapp and transfer execute on flags is not performed.
displaced_source_meshFalseWhether or not to use the displaced mesh for the source mesh.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to use the displaced mesh for the source mesh.
displaced_target_meshFalseWhether or not to use the displaced mesh for the target mesh.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to use the displaced mesh for the target mesh.
execute_onSAME_AS_MULTIAPPThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:SAME_AS_MULTIAPP
C++ Type:ExecFlagEnum
Options:XFEM_MARK, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, SAME_AS_MULTIAPP, POST_ADAPTIVITY
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
from_multi_appThe name of the MultiApp to receive data from
C++ Type:MultiAppName
Controllable:No
Description:The name of the MultiApp to receive data from
to_multi_appThe name of the MultiApp to transfer the data to
C++ Type:MultiAppName
Controllable:No
Description:The name of the MultiApp to transfer the data to

Optional Parameters

_called_legacy_paramsTrue
Default:True
C++ Type:bool
Controllable:No
control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
skip_coordinate_collapsingTrueWhether to skip coordinate collapsing (translation and rotation are still performed, only XYZ, RZ etc collapsing is skipped) when performing mapping and inverse mapping coordinate transformation operations. This parameter should only be set by users who really know what they're doing.
Default:True
C++ Type:bool
Controllable:No
Description:Whether to skip coordinate collapsing (translation and rotation are still performed, only XYZ, RZ etc collapsing is skipped) when performing mapping and inverse mapping coordinate transformation operations. This parameter should only be set by users who really know what they're doing.
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

Input Files

(test/tests/transfers/piecewise_function/to_master.i)
(test/tests/transfers/piecewise_function/from_master.i)
(test/tests/pra/sub.i)

(test/tests/transfers/piecewise_function/to_master.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./func]
    type = PiecewiseLinear
    x = '0 1'
    y = '777 888'
  [../]
[]

[MultiApps]
  [./sub]
    type = TransientMultiApp
    positions = '0 0 0'
    input_files = 'sub.i'
    execute_on = 'TIMESTEP_BEGIN'
  [../]
[]

[Transfers]
  [./transfer]
    type = PiecewiseFunctionTransfer
    to_multi_app = sub
    to_function = func
    from_function = func
  [../]
[]

[Postprocessors]
  [./func]
    type = FunctionValuePostprocessor
    function = func
    execute_on = 'INITIAL TIMESTEP_END'
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
  kernel_coverage_check = false
[]

[Executioner]
  type = Transient
  num_steps = 2
  dt = 0.5
[]

[Outputs]
  csv = true
[]

(test/tests/transfers/piecewise_function/to_master.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./func]
    type = PiecewiseLinear
    x = '0 1'
    y = '777 888'
  [../]
[]

[MultiApps]
  [./sub]
    type = TransientMultiApp
    positions = '0 0 0'
    input_files = 'sub.i'
    execute_on = 'TIMESTEP_BEGIN'
  [../]
[]

[Transfers]
  [./transfer]
    type = PiecewiseFunctionTransfer
    to_multi_app = sub
    to_function = func
    from_function = func
  [../]
[]

[Postprocessors]
  [./func]
    type = FunctionValuePostprocessor
    function = func
    execute_on = 'INITIAL TIMESTEP_END'
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
  kernel_coverage_check = false
[]

[Executioner]
  type = Transient
  num_steps = 2
  dt = 0.5
[]

[Outputs]
  csv = true
[]

(test/tests/transfers/piecewise_function/from_master.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./func]
    type = PiecewiseLinear
    x = '0 1'
    y = '777 888'
  [../]
[]

[MultiApps]
  [./sub]
    type = TransientMultiApp
    positions = '0 0 0'
    input_files = 'sub.i'
    execute_on = 'TIMESTEP_BEGIN'
  [../]
[]

[Transfers]
  [./transfer]
    type = PiecewiseFunctionTransfer
    from_multi_app = sub
    to_function = func
    from_function = func
  [../]
[]

[Postprocessors]
  [./func]
    type = FunctionValuePostprocessor
    function = func
    execute_on = "INITIAL TIMESTEP_END"
  [../]
[]

[Problem]
  type = FEProblem
  solve = false
  kernel_coverage_check = false
[]

[Executioner]
  type = Transient
  num_steps = 2
  dt = 0.5
[]

[Outputs]
  csv = true
[]

(test/tests/pra/sub.i)

# Test to demonstrate the Seismic Probabilistic Risk Assessment (SPRA)
# infrastructure in MASTODON. This test involves three input files:
#
# 1. master.i - The Master file that bins the hazard curve and scales ground
# motions for each bin for use in probabilistic simulations.
#
# 2. sub.i - The file that obtains the scaled ground motions from master.i and
# transfers these ground motions as inputs to the finite-element model and also
# contains the parameters for probabilistic simulation. This file acts as the
# sub file for master.i and master file for subsub.i.
#
# 3. subsub.i - The file that contains the finite-element model.

[Mesh]
  # dummy mesh
  type = GeneratedMesh
  dim = 3
[]

[Variables]
  # dummy variables
  [./u]
  [../]
[]

[Problem]
  solve = false
  kernel_coverage_check = false
[]

[Distributions]
  [./lognormal_density]
    type = Lognormal
    location = 0 # log(1.0); median = 1.0
    scale = 1.3
  [../]
[]

[Samplers]
  [./monte_carlo]
    # performs monte carlo sampling
    type = MonteCarlo
    num_rows = 2
    distributions = 'lognormal_density'
    execute_on = INITIAL # create random numbers on initial and use them for each timestep
  [../]
[]

[MultiApps]
  [./sub]
    # creates sub files for each monte carlo sample and each scaled ground motion
    # Total number of simulations = number_of_bins * num_gms * n_samples
    type = SamplerTransientMultiApp
    input_files = 'sub_sub.i'
    sampler = monte_carlo
    execute_on = TIMESTEP_BEGIN
  [../]
[]

[Transfers]
  [./sub]
    # transfers monte carlo samples to multiapp
    type = SamplerParameterTransfer
    to_multi_app = sub
    sampler = monte_carlo
    parameters = 'Materials/Elasticity_tensor_1/scale_factor_density'
    to_control = 'stochastic'
    execute_on = INITIAL
    check_multiapp_execute_on = false
  [../]
  [./transfer]
    # transfers scaled ground motions to multiapp
    type = PiecewiseFunctionTransfer
    to_multi_app = sub
    to_function = accel_bottom_x # name of function in subsub.i which uses the scaled ground motions
    from_function = accel_bottom_x # name of the function in sub.i, which receives the scaled ground motions
  [../]
[]

[Functions]
  [./accel_bottom_x]
    # Piecewiselinear function that receiving scaled GMs from master.i. Input here is dummy.
    type = PiecewiseLinear
    x = '32 34'
    y = '0 0'
  [../]
[]

[Executioner]
  type = Transient
[]

[Outputs]
  csv = true
[]

Description
Example Input File Syntax
Input Parameters
Input Files

Usage

Development

Demonstration