ValueRangeHeuristicUserObject Class Reference

#include <ValueRangeHeuristicUserObject.h>

Inheritance diagram for ValueRangeHeuristicUserObject:

Public Member Functions
	ValueRangeHeuristicUserObject (const InputParameters &params)
virtual bool	evaluate (libMesh::Elem *base_element, libMesh::Elem *neighbor_elem) const override
virtual void	execute () override
virtual void	initialize () override
virtual void	finalize () override

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
Real	getMetricData (const libMesh::Elem *elem) const

Protected Attributes
const Real &	_tolerance_percentage
	tolerance percentage for calculating the lower and upper limit More...
const Real &	_value
	user provided value More...
const Real	_upper_limit
	upper limit of the range More...
const Real	_lower_limit
	lower limit of the range More...
libMesh::MeshBase &	_mesh
	Mesh reference. More...
const AuxVariableName	_metric_variable_name
	Name of the metric variable based on which clustering is done. More...
const MooseVariableBase &	_metric_variable
	Metric variable. More...
AuxiliarySystem &	_auxiliary_system
	AuxiliarySystem reference. More...
const libMesh::DofMap &	_dof_map
	DOF map. More...
const unsigned int	_metric_variable_index
	Metric variable index. More...
NumericVector< Real > &	_serialized_metric_solution
	libmesh numeric vector with serialized solutions More...

Detailed Description

A clustering heuristic user object which clusters two neighboring elements whose metric variable values are within a user provided range

Constructor & Destructor Documentation

ValueRangeHeuristicUserObject()

ValueRangeHeuristicUserObject::ValueRangeHeuristicUserObject

(

const InputParameters &

params

)

Member Function Documentation

evaluate()

bool ValueRangeHeuristicUserObject::evaluate ( libMesh::Elem *  base_element, libMesh::Elem *  neighbor_elem  ) const

overridevirtual

A purely virtual function which must be overridden in derived classes. It applies the clustering logic for two elements in the derived class

Parameters

[in]	base_element	the current element
[in]	neighbor_elem	the current neighbour of base_element

Returns

whether the two elements should be added to a cluster or not

Implements ClusteringUserObjectBase.

execute()

virtual void ClusteringUserObjectBase::execute ( )

inlineoverridevirtualinherited

Reimplemented in ValueFractionHeuristicUserObject.

finalize()

virtual void ClusteringUserObjectBase::finalize ( )

inlineoverridevirtualinherited

getMetricData()

Real ClusteringUserObjectBase::getMetricData ( const libMesh::Elem *  elem ) const

protectedinherited

Get the metric data from the auxiliary system for an element.

Parameters

[in]

elem

Returns

value of the _metric_variable

initialize()

void ClusteringUserObjectBase::initialize ( )

overridevirtualinherited

validParams()

InputParameters ValueRangeHeuristicUserObject::validParams ( )

static

Member Data Documentation

_auxiliary_system

AuxiliarySystem& ClusteringUserObjectBase::_auxiliary_system

protectedinherited

AuxiliarySystem reference.

_dof_map

const libMesh::DofMap& ClusteringUserObjectBase::_dof_map

protectedinherited

DOF map.

_lower_limit

const Real ValueRangeHeuristicUserObject::_lower_limit

protected

lower limit of the range

_mesh

libMesh::MeshBase& ClusteringUserObjectBase::_mesh

protectedinherited

Mesh reference.

_metric_variable

const MooseVariableBase& ClusteringUserObjectBase::_metric_variable

protectedinherited

Metric variable.

_metric_variable_index

const unsigned int ClusteringUserObjectBase::_metric_variable_index

protectedinherited

Metric variable index.

_metric_variable_name

const AuxVariableName ClusteringUserObjectBase::_metric_variable_name

protectedinherited

Name of the metric variable based on which clustering is done.

_serialized_metric_solution

NumericVector<Real>& ClusteringUserObjectBase::_serialized_metric_solution

protectedinherited

libmesh numeric vector with serialized solutions

_tolerance_percentage

const Real& ValueRangeHeuristicUserObject::_tolerance_percentage

protected

tolerance percentage for calculating the lower and upper limit

_upper_limit

const Real ValueRangeHeuristicUserObject::_upper_limit

protected

upper limit of the range

_value

const Real& ValueRangeHeuristicUserObject::_value

protected

user provided value

---

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

• include/userobjects/ValueRangeHeuristicUserObject.h
• src/userobjects/ValueRangeHeuristicUserObject.C