MeshPropertyFunction

Converts a Real type mesh generator metadata into a constant function.

Description

The MeshPropertyFunction reads Real type metadata generated by a mesh generator and converts it into a constant function that can be used by other BISON modules.

Example Input Syntax

[Functions<<<{"href": "../../syntax/Functions/index.html"}>>>]
  [na_vol]
    type = MeshPropertyFunction<<<{"description": "Converts a Real type mesh generator metadata into a constant function.", "href": "MeshPropertyFunction.html"}>>>
    mesh_generator<<<{"description": "The name of the generator to use as the prefix for mesh meta data properties."}>>> = gen
    mesh_property_name<<<{"description": "The name of the mesh property that needs to be read."}>>> = sodium_volume
    scale_factor<<<{"description": "The constant factor used to scale the mesh property. A common use of this scale factor is to switch the sign of the mesh property."}>>> = -1.0
  []
[]
(test/tests/fipd_rodlet_mesh_generator/fipd_rodlet_mesh_generator_vol.i)

Input Parameters

  • mesh_generatorThe name of the generator to use as the prefix for mesh meta data properties.

    C++ Type:MeshGeneratorName

    Controllable:No

    Description:The name of the generator to use as the prefix for mesh meta data properties.

  • mesh_property_nameThe name of the mesh property that needs to be read.

    C++ Type:std::string

    Controllable:No

    Description:The name of the mesh property that needs to be read.

Required Parameters

  • scale_factor1The constant factor used to scale the mesh property. A common use of this scale factor is to switch the sign of the mesh property.

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The constant factor used to scale the mesh property. A common use of this scale factor is to switch the sign of the mesh property.

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