MoabUserObject

buildconstruction:Undocumented Class

The MoabUserObject 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.

Overview

Example Input File Syntax

Input Parameters

  • bin_densityFalseDetermine if elements should be additionally binned by material density

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Determine if elements should be additionally binned by material density

  • bin_varnameVariable name by whose results elements should be binned.

    C++ Type:std::string

    Controllable:No

    Description:Variable name by whose results elements should be binned.

  • density_nameVariable name for density by whose results elements should be binned.

    C++ Type:std::string

    Controllable:No

    Description:Variable name for density by whose results elements should be binned.

  • density_scale1Scale factor to convert densities from from MOOSE to OpenMC (latter is g/cc).

    Default:1

    C++ Type:double

    Controllable:No

    Description:Scale factor to convert densities from from MOOSE to OpenMC (latter is g/cc).

  • execute_onTIMESTEP_ENDThe 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:TIMESTEP_END

    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.

  • faceting_tol0.0001Faceting tolerance for DagMC

    Default:0.0001

    C++ Type:double

    Controllable:No

    Description:Faceting tolerance for DagMC

  • geom_tol1e-06Geometry tolerance for DagMC

    Default:1e-06

    C++ Type:double

    Controllable:No

    Description:Geometry tolerance for DagMC

  • graveyard_scale_inner1.01Graveyard inner surface scalefactor relative to aligned bounding box.

    Default:1.01

    C++ Type:double

    Controllable:No

    Description:Graveyard inner surface scalefactor relative to aligned bounding box.

  • graveyard_scale_outer1.1Graveyard outer surface scalefactor relative to aligned bounding box.

    Default:1.1

    C++ Type:double

    Controllable:No

    Description:Graveyard outer surface scalefactor relative to aligned bounding box.

  • length_scale100Scale factor to convert lengths from MOOSE to MOAB. Default is from metres->centimetres.

    Default:100

    C++ Type:double

    Controllable:No

    Description:Scale factor to convert lengths from MOOSE to MOAB. Default is from metres->centimetres.

  • logscaleFalseSwitch to determine if logarithmic binning should be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Switch to determine if logarithmic binning should be used.

  • material_namesList of MOOSE material names

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:List of MOOSE material names

  • material_openmc_namesList of OpenMC material names

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:List of OpenMC material names

  • n_bins60Number of bins

    Default:60

    C++ Type:unsigned int

    Controllable:No

    Description:Number of bins

  • n_density_bins5Number of relative density bins

    Default:5

    C++ Type:unsigned int

    Controllable:No

    Description:Number of relative density bins

  • n_output10Number of times to write to file if output_skins and/or output_full is true

    Default:10

    C++ Type:unsigned int

    Controllable:No

    Description:Number of times to write to file if output_skins and/or output_full is true

  • n_skip0Number of iterations to skip between writes if output_skins and/or output_full is true and n_output>1

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:Number of iterations to skip between writes if output_skins and/or output_full is true and n_output>1

  • output_basemoab_surfsBase filename for surface file writes (will be appended by an integer

    Default:moab_surfs

    C++ Type:std::string

    Controllable:No

    Description:Base filename for surface file writes (will be appended by an integer

  • output_base_fullmoab_fullBase filename for full mesh file writes (will be appended by an integer

    Default:moab_full

    C++ Type:std::string

    Controllable:No

    Description:Base filename for full mesh file writes (will be appended by an integer

  • output_fullFalseSwitch to control whether MOAB should write full mesh data to file.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Switch to control whether MOAB should write full mesh data to file.

  • output_skinsFalseSwitch to control whether MOAB should write skins to file.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Switch to control whether MOAB should write skins to file.

  • rel_den_max0.1Maximum difference in density relative to original material density

    Default:0.1

    C++ Type:double

    Controllable:No

    Description:Maximum difference in density relative to original material density

  • rel_den_min-0.1Minimum difference in density relative to original material density

    Default:-0.1

    C++ Type:double

    Controllable:No

    Description:Minimum difference in density relative to original material density

  • var_max597.5Max value to define range of bins.

    Default:597.5

    C++ Type:double

    Controllable:No

    Description:Max value to define range of bins.

  • var_min297.5Minimum value to define range of bins.

    Default:297.5

    C++ Type:double

    Controllable:No

    Description:Minimum value to define range of bins.

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Controllable:No

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • 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.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

  • 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