- flood_counterThe FeatureFloodCount UserObject to get values from.
C++ Type:UserObjectName
Controllable:No
Description:The FeatureFloodCount UserObject to get values from.
FeatureVolumeVectorPostprocessor
This VectorPostprocessor is designed to pull data from a FeatureFloodCount or one of its derived classes. In particular, the FeatureFloodCount object stores information about each connected component that it discovers: volumes, whether or not that component intersects a boundary, and the variable number.
If this VPP is used with a GrainTracker or derived object, the row number represents the unique identifier of each feature. This value is stable between time steps meaning that row number 5 would always represent the grain with an ID of 5 (zero-based indexing). This also means that information from inactive grains is output and should be ignored. Inactive grains are identified with var_num == -1.
When using this VPP with a FeatureFloodCount object, there is no implied ordering of the features.
var_num - The index of which coupled variable represents this feature [0..n).
feature_volume - The volume of the feature, computed as an integral of the solution over each element representing this feature.
intersects_bounds - A Boolean indicating whether this feature intersects any boundary.
centroid_<x, y, z> (optional) - The coordinates of each feature centroid (Currently only supported when no periodic boundaries are used).
Typical Output
var_num,feature_volumes,intersects_bounds,intersects_specified_bounds,percolated
0,3.1408620543406,0,0,0
1,1.02515625,0,0,0
1,0.26265625,0,0,0
Centroid Output
This VectorPosptrocessor can also output centroid information when the simulation is not using periodic boundary conditions. To enable centroid output, add output_centroids = true to the VPP block in your input file.
Usage
To use this VPP, you simply need to specify the name of a FeatureFloodCount or derived object in the input file.
[VectorPostprocessors]
[./grain_volumes]
type = FeatureVolumeVectorPostprocessor
flood_counter = grain_tracker
execute_on = 'initial'
[../]
[]
Advanced Parameter(s)
The single_feature_per_element parameter is a crude attempt at total volume conservation. When you set this Boolean to true, the volume of every element will be added only to the most dominant feature. In this manner, the loss of an element in one feature results in the addition of an element to another feature. There is no loss of volume to grain boundaries or anything else using this assumption.
Class Description
This object is designed to pull information from the data structures of a "FeatureFloodCount" or derived object (e.g. individual feature volumes)
Input Parameters
- boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
- 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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
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, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.
- output_centroidsFalseSet to true to output the feature centroids
Default:False
C++ Type:bool
Controllable:No
Description:Set to true to output the feature centroids
- parallel_typeREPLICATEDSet how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.
Default:REPLICATED
C++ Type:MooseEnum
Controllable:No
Description:Set how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.
- prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
- single_feature_per_elementFalseSet this Boolean if you wish to use an element based volume where the dominant order parameter determines the feature that accumulates the entire element volume
Default:False
C++ Type:bool
Controllable:No
Description:Set this Boolean if you wish to use an element based volume where the dominant order parameter determines the feature that accumulates the entire element volume
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.
- execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
- 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
- outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
- 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.