AverageGrainVolume.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("PhaseFieldApp", AverageGrainVolume)
template<>
InputParameters	validParams< AverageGrainVolume > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"PhaseFieldApp"	,
		AverageGrainVolume
	)

validParams< AverageGrainVolume >()

template<>

InputParameters validParams< AverageGrainVolume >

(

)

This object has two modes of operation: It can be used with the FeatureFloodCount object (recommended) to get the active grain on element information needed to calculate volumes. It can also work on small polycrystals where an equal number of grains and order parameters are used in the simulation. This dual-functionality creates two separate code paths and parameter sets.

Definition at line 22 of file AverageGrainVolume.C.

{
  InputParameters params = validParams<GeneralPostprocessor>();
  params.addClassDescription("Calculate average grain area in a polycrystal");
 
  // Mode 1: Use the GrainTracker
  params.addParam<UserObjectName>("feature_counter",
                                  "The FeatureFloodCount UserObject to get values from.");
 
  // Mode 2: Calculate grain volumes adirectly
  params.addCoupledVarWithAutoBuild(
      "variable", "var_name_base", "op_num", "Array of coupled variables");
  params.addParam<unsigned int>("grain_num", "number of grains to create");
  return params;
}