FeatureFloodCountAux Class Reference

Function auxiliary value. More...

#include <FeatureFloodCountAux.h>

Inheritance diagram for FeatureFloodCountAux:

Public Member Functions
	FeatureFloodCountAux (const InputParameters &parameters)
	Factory constructor, takes parameters so that all derived classes can be built using the same constructor. More...
virtual	~FeatureFloodCountAux ()

Protected Member Functions
virtual Real	computeValue () override
virtual void	precalculateValue () override

Protected Attributes
const FeatureFloodCount &	_flood_counter
	Function being used to compute the value of this kernel. More...
const std::size_t	_var_idx
const MooseEnum	_field_display
bool	_var_coloring
const FeatureFloodCount::FieldType	_field_type
Real	_value
	precalculated element value More...

Detailed Description

Function auxiliary value.

Definition at line 25 of file FeatureFloodCountAux.h.

Constructor & Destructor Documentation

FeatureFloodCountAux()

FeatureFloodCountAux::FeatureFloodCountAux

(

const InputParameters &

parameters

)

Factory constructor, takes parameters so that all derived classes can be built using the same constructor.

Definition at line 47 of file FeatureFloodCountAux.C.

  : AuxKernel(parameters),
    _flood_counter(getUserObject<FeatureFloodCount>("flood_counter")),
    _var_idx(isParamValid("map_index") ? getParam<unsigned int>("map_index")
                                       : std::numeric_limits<std::size_t>::max()),
    _field_display(getParam<MooseEnum>("field_display")),
    _var_coloring(_field_display == "VARIABLE_COLORING"),
    _field_type(_field_display.getEnum<FeatureFloodCount::FieldType>())
{
  if (_flood_counter.isElemental() == isNodal() &&
      (_field_display == "UNIQUE_REGION" || _field_display == "VARIABLE_COLORING" ||
       _field_display == "GHOSTED_ENTITIES" || _field_display == "HALOS"))
    mooseError("UNIQUE_REGION, VARIABLE_COLORING, GHOSTED_ENTITIES and HALOS must be on variable "
               "types that match the entity mode of the FeatureFloodCounter");
 
  if (isNodal())
  {
    if (_field_display == "ACTIVE_BOUNDS")
      mooseError("ACTIVE_BOUNDS is only available for elemental aux variables");
 
    if (_field_display == "CENTROID")
      mooseError("CENTROID is only available for elemental aux variables");
  }
}

~FeatureFloodCountAux()

virtual FeatureFloodCountAux::~FeatureFloodCountAux ( )

inlinevirtual

Definition at line 34 of file FeatureFloodCountAux.h.

{}

Member Function Documentation

computeValue()

Real FeatureFloodCountAux::computeValue ( )

overrideprotectedvirtual

Definition at line 101 of file FeatureFloodCountAux.C.

{
  return _value;
}

precalculateValue()

void FeatureFloodCountAux::precalculateValue ( )

overrideprotectedvirtual

Definition at line 73 of file FeatureFloodCountAux.C.

{
  switch (_field_display)
  {
    case 0: // UNIQUE_REGION
    case 1: // VARIABLE_COLORING
    case 2: // GHOSTED_ENTITIES
    case 3: // HALOS
    case 4: // CENTROID
      _value = _flood_counter.getEntityValue(
          (isNodal() ? _current_node->id() : _current_elem->id()), _field_type, _var_idx);
      break;
    case 5: // ACTIVE_BOUNDS
    {
      const auto & var_to_features = _flood_counter.getVarToFeatureVector(_current_elem->id());
      _value = std::count_if(
          var_to_features.begin(), var_to_features.end(), [](unsigned int feature_id) {
            return feature_id != FeatureFloodCount::invalid_id;
          });
 
      break;
    }
    default:
      mooseError("Unimplemented \"field_display\" type");
  }
}

Member Data Documentation

_field_display

const MooseEnum FeatureFloodCountAux::_field_display

protected

Definition at line 44 of file FeatureFloodCountAux.h.

Referenced by FeatureFloodCountAux(), and precalculateValue().

_field_type

const FeatureFloodCount::FieldType FeatureFloodCountAux::_field_type

protected

Definition at line 47 of file FeatureFloodCountAux.h.

Referenced by precalculateValue().

_flood_counter

const FeatureFloodCount& FeatureFloodCountAux::_flood_counter

protected

Function being used to compute the value of this kernel.

Definition at line 41 of file FeatureFloodCountAux.h.

Referenced by FeatureFloodCountAux(), and precalculateValue().

_value

Real FeatureFloodCountAux::_value

protected

precalculated element value

Definition at line 50 of file FeatureFloodCountAux.h.

Referenced by computeValue(), and precalculateValue().

_var_coloring

bool FeatureFloodCountAux::_var_coloring

protected

Definition at line 45 of file FeatureFloodCountAux.h.

_var_idx

const std::size_t FeatureFloodCountAux::_var_idx

protected

Definition at line 43 of file FeatureFloodCountAux.h.

Referenced by precalculateValue().

---

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

• phase_field/include/auxkernels/FeatureFloodCountAux.h
• phase_field/src/auxkernels/FeatureFloodCountAux.C