Axisymmetric2D3DSolutionFunction

under construction:Undocumented Class

The Axisymmetric2D3DSolutionFunction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# Axisymmetric2D3DSolutionFunction

!syntax description /Functions/Axisymmetric2D3DSolutionFunction

## Overview

!! Replace these lines with information regarding the Axisymmetric2D3DSolutionFunction object.

## Example Input File Syntax

!! Describe and include an example of how to use the Axisymmetric2D3DSolutionFunction object.

!syntax parameters /Functions/Axisymmetric2D3DSolutionFunction

!syntax inputs /Functions/Axisymmetric2D3DSolutionFunction

!syntax children /Functions/Axisymmetric2D3DSolutionFunction

Function for reading a 2D axisymmetric solution from file and mapping it to a 3D Cartesian model

Input Parameters

  • solutionThe SolutionUserObject to extract data from.

    C++ Type:UserObjectName

    Options:

    Description:The SolutionUserObject to extract data from.

Required Parameters

  • 2d_axis_point10 0 0Start point for axis of symmetry for the 2d model

    Default:0 0 0

    C++ Type:libMesh::VectorValue

    Options:

    Description:Start point for axis of symmetry for the 2d model

  • 2d_axis_point20 1 0End point for axis of symmetry for the 2d model

    Default:0 1 0

    C++ Type:libMesh::VectorValue

    Options:

    Description:End point for axis of symmetry for the 2d model

  • 3d_axis_point10 0 0Start point for axis of symmetry for the 3d model

    Default:0 0 0

    C++ Type:libMesh::VectorValue

    Options:

    Description:Start point for axis of symmetry for the 3d model

  • 3d_axis_point20 1 0End point for axis of symmetry for the 3d model

    Default:0 1 0

    C++ Type:libMesh::VectorValue

    Options:

    Description:End point for axis of symmetry for the 3d model

  • add_factor0Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'

    Default:0

    C++ Type:double

    Options:

    Description:Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'

  • axial_dimension_ratio1Ratio of the axial dimension in the 3d model to that in the 2d model. Optinally permits the 3d model to be larger than the 2d model in that dimension, and scales vector solutions in that direction by this factor.

    Default:1

    C++ Type:double

    Options:

    Description:Ratio of the axial dimension in the 3d model to that in the 2d model. Optinally permits the 3d model to be larger than the 2d model in that dimension, and scales vector solutions in that direction by this factor.

  • componentComponent of the variable to be computed if it is a vector

    C++ Type:unsigned int

    Options:

    Description:Component of the variable to be computed if it is a vector

  • from_variablesThe names of the variables in the file that are to be extracted, in x, y order if they are vector components

    C++ Type:std::vector

    Options:

    Description:The names of the variables in the file that are to be extracted, in x, y order if they are vector components

  • scale_factor1Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'

    Default:1

    C++ Type:double

    Options:

    Description:Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files