FeatureVolumeFraction Class Reference

#include <FeatureVolumeFraction.h>

Inheritance diagram for FeatureVolumeFraction:

Public Member Functions
	FeatureVolumeFraction (const InputParameters &parameters)
virtual void	initialize () override
virtual void	execute () override
virtual Real	getValue () override

Protected Types
enum	ValueType { ValueType::VOLUME_FRACTION, ValueType::AVRAMI }

Protected Member Functions
Real	calculateAvramiValue ()

Protected Attributes
const ValueType	_value_type
const PostprocessorValue &	_mesh_volume
const VectorPostprocessorValue &	_feature_volumes
Real	_volume_fraction
Real	_equil_fraction
Real	_avrami_value

Detailed Description

Definition at line 20 of file FeatureVolumeFraction.h.

Member Enumeration Documentation

ValueType

enum FeatureVolumeFraction::ValueType

strongprotected

Enumerator
VOLUME_FRACTION
AVRAMI

Definition at line 32 of file FeatureVolumeFraction.h.

  {
    VOLUME_FRACTION,
    AVRAMI,
  };

Constructor & Destructor Documentation

FeatureVolumeFraction()

FeatureVolumeFraction::FeatureVolumeFraction

(

const InputParameters &

parameters

)

Definition at line 32 of file FeatureVolumeFraction.C.

  : GeneralPostprocessor(parameters),
    _value_type(getParam<MooseEnum>("value_type").getEnum<ValueType>()),
    _mesh_volume(getPostprocessorValue("mesh_volume")),
    _feature_volumes(getVectorPostprocessorValue("feature_volumes", "feature_volumes")),
    _equil_fraction(getParam<Real>("equil_fraction")),
    _avrami_value(0)
{
}

Member Function Documentation

calculateAvramiValue()

Real FeatureVolumeFraction::calculateAvramiValue ( )

protected

Definition at line 77 of file FeatureVolumeFraction.C.

{
  return std::log(std::log(1.0 / (1.0 - (_volume_fraction / _equil_fraction))));
}

Referenced by execute().

execute()

void FeatureVolumeFraction::execute ( )

overridevirtual

Definition at line 48 of file FeatureVolumeFraction.C.

{
  Real volume = 0.0;
 
  // sum the values in the vector to get total volume
  for (const auto & feature_volume : _feature_volumes)
    volume += feature_volume;
 
  mooseAssert(!MooseUtils::absoluteFuzzyEqual(_mesh_volume, 0.0), "Mesh volume is zero");
  _volume_fraction = volume / _mesh_volume;
 
  _avrami_value = calculateAvramiValue();
}

getValue()

Real FeatureVolumeFraction::getValue ( )

overridevirtual

Definition at line 63 of file FeatureVolumeFraction.C.

{
  switch (_value_type)
  {
    case ValueType::VOLUME_FRACTION:
      return _volume_fraction;
    case ValueType::AVRAMI:
      return _avrami_value;
    default:
      return 0;
  }
}

initialize()

void FeatureVolumeFraction::initialize ( )

overridevirtual

Definition at line 43 of file FeatureVolumeFraction.C.

{
}

Member Data Documentation

_avrami_value

Real FeatureVolumeFraction::_avrami_value

protected

Definition at line 44 of file FeatureVolumeFraction.h.

Referenced by execute(), and getValue().

_equil_fraction

Real FeatureVolumeFraction::_equil_fraction

protected

Definition at line 43 of file FeatureVolumeFraction.h.

Referenced by calculateAvramiValue().

_feature_volumes

const VectorPostprocessorValue& FeatureVolumeFraction::_feature_volumes

protected

Definition at line 40 of file FeatureVolumeFraction.h.

Referenced by execute().

_mesh_volume

const PostprocessorValue& FeatureVolumeFraction::_mesh_volume

protected

Definition at line 39 of file FeatureVolumeFraction.h.

Referenced by execute().

_value_type

const ValueType FeatureVolumeFraction::_value_type

protected

Definition at line 38 of file FeatureVolumeFraction.h.

Referenced by getValue().

_volume_fraction

Real FeatureVolumeFraction::_volume_fraction

protected

Definition at line 42 of file FeatureVolumeFraction.h.

Referenced by calculateAvramiValue(), execute(), and getValue().

---

The documentation for this class was generated from the following files:

• phase_field/include/postprocessors/FeatureVolumeFraction.h
• phase_field/src/postprocessors/FeatureVolumeFraction.C