ClusteringUserObjectBase Class Reference

#include <ClusteringUserObjectBase.h>

Inheritance diagram for ClusteringUserObjectBase:

Public Member Functions
	ClusteringUserObjectBase (const InputParameters &parameters)
virtual void	execute () override
virtual void	initialize () override
virtual void	finalize () override
virtual bool	evaluate (libMesh::Elem *base_element, libMesh::Elem *neighbor_elem) const =0

Static Public Member Functions
static InputParameters	validParams ()

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

Protected Attributes
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...

Constructor & Destructor Documentation

ClusteringUserObjectBase()

ClusteringUserObjectBase::ClusteringUserObjectBase

(

const InputParameters &

parameters

)

Member Function Documentation

evaluate()

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

pure virtual

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

Implemented in ThresholdHeuristicUserObject, ValueDifferenceHeuristicUserObject, ValueFractionHeuristicUserObject, and ValueRangeHeuristicUserObject.

execute()

virtual void ClusteringUserObjectBase::execute ( )

inlineoverridevirtual

Reimplemented in ValueFractionHeuristicUserObject.

finalize()

virtual void ClusteringUserObjectBase::finalize ( )

inlineoverridevirtual

getMetricData()

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

protected

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

Parameters

[in]

elem

Returns

value of the _metric_variable

initialize()

void ClusteringUserObjectBase::initialize ( )

overridevirtual

validParams()

InputParameters ClusteringUserObjectBase::validParams ( )

static

Member Data Documentation

_auxiliary_system

AuxiliarySystem& ClusteringUserObjectBase::_auxiliary_system

protected

AuxiliarySystem reference.

_dof_map

const libMesh::DofMap& ClusteringUserObjectBase::_dof_map

protected

DOF map.

_mesh

libMesh::MeshBase& ClusteringUserObjectBase::_mesh

protected

Mesh reference.

_metric_variable

const MooseVariableBase& ClusteringUserObjectBase::_metric_variable

protected

Metric variable.

_metric_variable_index

const unsigned int ClusteringUserObjectBase::_metric_variable_index

protected

Metric variable index.

_metric_variable_name

const AuxVariableName ClusteringUserObjectBase::_metric_variable_name

protected

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

_serialized_metric_solution

NumericVector<Real>& ClusteringUserObjectBase::_serialized_metric_solution

protected

libmesh numeric vector with serialized solutions

---

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

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