ValueFractionHeuristicUserObject Class Reference

#include <ValueFractionHeuristicUserObject.h>

Inheritance diagram for ValueFractionHeuristicUserObject:

Public Member Functions
	ValueFractionHeuristicUserObject (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
void	extremesFinder ()
	maximum and minimum value finder More...
Real	getMetricData (const libMesh::Elem *elem) const

Protected Attributes
Real	_upper_fraction
	upper fraction of the metric value More...
Real	_lower_fraction
	lower fraction of the metric value More...
Real	_max
	maximum value of the metric More...
Real	_min
	minimum value of the metric More...
Real	_upper_cut_off
	upper cut off of the metric value More...
Real	_lower_cut_off
	upper cut off of the metric value 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 either more/less than a percentage of extremes.

Constructor & Destructor Documentation

ValueFractionHeuristicUserObject()

ValueFractionHeuristicUserObject::ValueFractionHeuristicUserObject

(

const InputParameters &

params

)

Member Function Documentation

evaluate()

bool ValueFractionHeuristicUserObject::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 ValueFractionHeuristicUserObject::execute ( )

inlineoverridevirtual

Reimplemented from ClusteringUserObjectBase.

extremesFinder()

void ValueFractionHeuristicUserObject::extremesFinder ( )

protected

maximum and minimum value finder

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 ValueFractionHeuristicUserObject::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_cut_off

Real ValueFractionHeuristicUserObject::_lower_cut_off

protected

upper cut off of the metric value

_lower_fraction

Real ValueFractionHeuristicUserObject::_lower_fraction

protected

lower fraction of the metric value

_max

Real ValueFractionHeuristicUserObject::_max

protected

maximum value of the metric

_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.

_min

Real ValueFractionHeuristicUserObject::_min

protected

minimum value of the metric

_serialized_metric_solution

NumericVector<Real>& ClusteringUserObjectBase::_serialized_metric_solution

protectedinherited

libmesh numeric vector with serialized solutions

_upper_cut_off

Real ValueFractionHeuristicUserObject::_upper_cut_off

protected

upper cut off of the metric value

_upper_fraction

Real ValueFractionHeuristicUserObject::_upper_fraction

protected

upper fraction of the metric value

---

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

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