NekUserObject Class Reference

#include <NekUserObject.h>

Inheritance diagram for NekUserObject:

Public Member Functions
	NekUserObject (const InputParameters &parameters)
virtual void	initialize ()
virtual void	finalize ()
virtual void	execute () override
virtual void	executeUserObject ()=0

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const unsigned int &	_interval
	Interval with which to evaluate the user object. More...
const NekRSProblemBase *	_nek_problem
	Underlying problem object. More...
bool	_fixed_mesh
	Whether the mesh this userobject operates on is fixed, allowing caching of volumes and areas. More...

Detailed Description

Base class for providing common information to userobjects operating directly on the NekRS solution and mesh.

Constructor & Destructor Documentation

NekUserObject()

NekUserObject::NekUserObject

(

const InputParameters &

parameters

)

Member Function Documentation

execute()

virtual void NekUserObject::execute ( )

overridevirtual

executeUserObject()

virtual void NekUserObject::executeUserObject ( )

pure virtual

Execute the user object; separating this call from execute() allows all derived classes to leverage this base class's 'interval' parameter to decide when to call the user object

Implemented in NekBinnedVolumeIntegral, NekBinnedPlaneAverage, NekBinnedPlaneIntegral, NekBinnedSideAverage, NekBinnedSideIntegral, and NekBinnedVolumeAverage.

finalize()

virtual void NekUserObject::finalize ( )

inlinevirtual

initialize()

virtual void NekUserObject::initialize ( )

inlinevirtual

validParams()

static InputParameters NekUserObject::validParams ( )

static

Member Data Documentation

_fixed_mesh

bool NekUserObject::_fixed_mesh

protected

Whether the mesh this userobject operates on is fixed, allowing caching of volumes and areas.

_interval

const unsigned int& NekUserObject::_interval

protected

Interval with which to evaluate the user object.

_nek_problem

const NekRSProblemBase* NekUserObject::_nek_problem

protected

Underlying problem object.

---

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

• include/userobjects/NekUserObject.h