ElementPropertyReadFile

User Object to read property data from an external file and assign to elements.

This user object has two modes to operate in, which are toggled using the read_type parameter.

  • In element mode a file is read in that contains nprop values for each element in the mesh. The element IDs are expected to be consecutive numbers starting at zero.

  • In grain mode a Voronoi tessellation with ngrain random centers is created assuming an orthogonal rectangular periodic mesh. A file is read in that contains nprop values for each grain.

Values can be queried from the object by passing in a property ID and an element pointer. In element mode a direct lookup from the data table based on element ID is performed. In grain mode the centroid of the passed in element is taken and the grain ID is determined as the ID of the Voronoi center closest to the element centroid.

Input Parameters

  • npropNumber of tabulated property values

    C++ Type:unsigned int

    Options:

    Description:Number of tabulated property values

  • read_typeType of property distribution: element:element by element property variation; grain:voronoi grain structure

    C++ Type:MooseEnum

    Options:element grain

    Description:Type of property distribution: element:element by element property variation; grain:voronoi grain structure

Required Parameters

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

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    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.

  • ngrain0Number of grains

    Default:0

    C++ Type:unsigned int

    Options:

    Description:Number of grains

  • prop_file_nameName of the property file name

    C++ Type:FileName

    Options:

    Description:Name of the property file name

  • rand_seed2000random seed

    Default:2000

    C++ Type:unsigned int

    Options:

    Description:random seed

  • rve_typenonePeriodic or non-periodic grain distribution: Default is non-periodic

    Default:none

    C++ Type:MooseEnum

    Options:periodic none

    Description:Periodic or non-periodic grain distribution: Default is non-periodic

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

    Options:

    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

    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.

  • force_preauxFalseForces the GeneralUserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Options:

    Description:Forces the GeneralUserObject to be executed in PREAUX

  • 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

    Options:

    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

References