FeatureVolumeVectorPostprocessor.h File Reference

Go to the source code of this file.

Classes
class	FeatureVolumeVectorPostprocessor
	This VectorPostprocessor is intended to be used to calculate accurate volumes from the FeatureFloodCount and/or GrainTracker objects. More...

Functions
template<>
InputParameters	validParams< FeatureVolumeVectorPostprocessor > ()

Function Documentation

validParams< FeatureVolumeVectorPostprocessor >()

template<>

InputParameters validParams< FeatureVolumeVectorPostprocessor >

(

)

Definition at line 25 of file FeatureVolumeVectorPostprocessor.C.

{
  InputParameters params = validParams<GeneralVectorPostprocessor>();
  params += validParams<BoundaryRestrictable>();
 
  params.addRequiredParam<UserObjectName>("flood_counter",
                                          "The FeatureFloodCount UserObject to get values from.");
  params.addParam<bool>("single_feature_per_element",
                        false,
                        "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");
  params.addParam<bool>("output_centroids", false, "Set to true to output the feature centroids");
  params.addClassDescription("This object is designed to pull information from the data structures "
                             "of a \"FeatureFloodCount\" or derived object (e.g. individual "
                             "feature volumes)");
 
  params.suppressParameter<bool>("contains_complete_history");
 
  return params;
}