Cardinal
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ErrorFractionLookAheadMarker Class Reference

#include <ErrorFractionLookAheadMarker.h>

Inheritance diagram for ErrorFractionLookAheadMarker:
[legend]

Public Member Functions

 ErrorFractionLookAheadMarker (const InputParameters &parameters)
 
virtual void markerSetup () override
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

virtual MarkerValue computeElementMarker () override
 

Protected Attributes

const Real & _rel_error_limit
 
ErrorVector & _rel_error_vec
 The relative error reported by an indicator. More...
 

Detailed Description

A class which estimates the relative error of a tally score post-refinement. Elements are only marked for refinement if the predicted error is less than a threshold specified by the user and ErrorFractionMarker would mark the element for refinement.

Constructor & Destructor Documentation

◆ ErrorFractionLookAheadMarker()

ErrorFractionLookAheadMarker::ErrorFractionLookAheadMarker ( const InputParameters &  parameters)

Member Function Documentation

◆ computeElementMarker()

Marker::MarkerValue ErrorFractionLookAheadMarker::computeElementMarker ( )
overrideprotectedvirtual

◆ markerSetup()

void ErrorFractionLookAheadMarker::markerSetup ( )
overridevirtual

◆ validParams()

InputParameters ErrorFractionLookAheadMarker::validParams ( )
static

Member Data Documentation

◆ _rel_error_limit

const Real& ErrorFractionLookAheadMarker::_rel_error_limit
protected

Upper relative error limit for refinement. If the "lookahead" for an element exceeds this limit, don't refine. Otherwise, mark for refinement.

◆ _rel_error_vec

ErrorVector& ErrorFractionLookAheadMarker::_rel_error_vec
protected

The relative error reported by an indicator.


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