CosineTransitionFunction

Computes a cosine transtition of a user-specified width between two values

This function uses WeightedTransition to smoothly transition between two values in time or along a spatial axis.

Input Parameters

axisCoordinate axis on which the transition occurs
C++ Type:MooseEnum
Options:x, y, z, t
Controllable:No
Description:Coordinate axis on which the transition occurs
function1First function
C++ Type:FunctionName
Controllable:No
Description:First function
function2Second function
C++ Type:FunctionName
Controllable:No
Description:Second function
transition_centerCenter position of transition
C++ Type:double
Controllable:No
Description:Center position of transition
transition_widthWidth of transition
C++ Type:double
Controllable:No
Description:Width of transition

Required Parameters

execute_onLINEARThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS.
Default:LINEAR
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS
Controllable:No
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, ALWAYS.

Optional Parameters

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:No
Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files

(modules/thermal_hydraulics/test/tests/functions/smooth_transition/time.i)
(modules/thermal_hydraulics/test/tests/functions/smooth_transition/space.i)
(modules/thermal_hydraulics/test/tests/functions/piecewise_function/piecewise_function.i)

References

No citations exist within this document.

(modules/thermal_hydraulics/test/tests/functions/smooth_transition/time.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 1
[]

[Executioner]
  type = Transient
  dt = 1
  num_steps = 10
[]

[Problem]
  solve = false
[]

[Functions]
  [transition_fn]
    type = CosineTransitionFunction
    axis = t
    transition_center = 5
    transition_width = 4
    function1 = 0
    function2 = 100
  []
[]

[Postprocessors]
  [transition]
    type = FunctionValuePostprocessor
    function = transition_fn
    execute_on = 'initial timestep_end'
  []
[]

[Outputs]
  csv = true
  file_base = time_weighted
[]

(modules/thermal_hydraulics/test/tests/functions/smooth_transition/space.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 1
  ny = 100
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
[]

[Functions]
  [transition_fn]
    type = CosineTransitionFunction
    axis = y
    transition_center = 0.3
    transition_width = 0.4
    function1 = 0
    function2 = 100
  []
[]

[AuxVariables]
  [transition]
    order = FIRST
    family = LAGRANGE
  []
[]

[AuxKernels]
  [transition_kernel]
    type = FunctionAux
    variable = transition
    function = transition_fn
    execute_on = initial
  []
[]

[Outputs]
  exodus = true
  show = transition
  file_base = space_weighted
  execute_on = initial
[]

(modules/thermal_hydraulics/test/tests/functions/piecewise_function/piecewise_function.i)

# This test tests the PiecewiseFunction, which pieces functions together.
# Piecing together the 2 CosineTransitionFunction functions should yield the
# CosineHumpFunction function. This test samples the PiecewiseFunction and the
# CosineHumpFunction and compares the samples using the
# VectorPostprocessorComparison post-processor.

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 1
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
[]

[Functions]
  [function_left]
    type = CosineTransitionFunction
    axis = y
    transition_center = 2
    transition_width = 2
    function1 = 5
    function2 = 20
  []
  [function_right]
    type = CosineTransitionFunction
    axis = y
    transition_center = 4
    transition_width = 2
    function1 = 20
    function2 = 5
  []
  [function_end]
    type = ConstantFunction
    value = 5
  []
  [function_piecewise]
    type = PiecewiseFunction
    axis = y
    axis_coordinates = '3 5'
    functions = 'function_left function_right function_end'
  []
  [function_gold]
    type = CosineHumpFunction
    axis = y
    hump_center_position = 3
    hump_width = 4
    hump_begin_value = 5
    hump_center_value = 20
  []
[]

[VectorPostprocessors]
  [piecewise_function_vpp]
    type = LineFunctionSampler
    functions = 'function_piecewise function_gold'
    sort_by = y
    start_point = '0 0 0'
    end_point = '0 6 0'
    num_points = 20
    execute_on = 'initial'
  []
[]

[Postprocessors]
  [matches_gold]
    type = VectorPostprocessorComparison
    comparison_type = equals
    vectorpostprocessor_a = piecewise_function_vpp
    vectorpostprocessor_b = piecewise_function_vpp
    vector_name_a = function_piecewise
    vector_name_b = function_gold
    execute_on = 'initial'
  []
[]

[Outputs]
  csv = true
  show = 'matches_gold'
  execute_on = 'initial'
[]

Input Parameters
Input Files
References

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access