NekScalarValue Class Reference

#include <NekScalarValue.h>

Inheritance diagram for NekScalarValue:

Public Member Functions
	NekScalarValue (const InputParameters &parameters)
virtual void	execute () override
	We don't want this user object to execute in MOOSE's control. More...
virtual void	initialize () override
virtual void	finalize () override
virtual void	setValue ()
	Instead, we want to have a separate method that we can call from NekRSProblemBase. More...
Real	getValue () const
virtual unsigned int	usrwrkSlot () const
virtual void	setCounter (const unsigned int &counter)
virtual const unsigned int &	counter () const

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const Real &	_value
	The value to send into NekRS. More...
const Real &	_scaling
	A multiplier to apply to 'value'. More...
unsigned int	_usrwrk_slot
	Slot in usrwrk to write the scalar value. More...
unsigned int	_counter
	Counter of this object, to be set by NekRSProblem. More...

Detailed Description

Opaque user object which will send a scalar value into NekRS through its scratch space. The user then has infinite flexibility to use that value in the NekRS case files.

Constructor & Destructor Documentation

NekScalarValue()

NekScalarValue::NekScalarValue

(

const InputParameters &

parameters

)

Member Function Documentation

counter()

virtual const unsigned int& NekScalarValue::counter ( ) const

inlinevirtual

Get the index in usrwrk for which this scalar value is held

Returns

usrwrk index

execute()

virtual void NekScalarValue::execute ( )

inlineoverridevirtual

We don't want this user object to execute in MOOSE's control.

finalize()

virtual void NekScalarValue::finalize ( )

inlineoverridevirtual

getValue()

Real NekScalarValue::getValue

(

)

const

Get the value currently held by this user object

Returns

value

initialize()

virtual void NekScalarValue::initialize ( )

inlineoverridevirtual

setCounter()

virtual void NekScalarValue::setCounter ( const unsigned int &  counter )

inlinevirtual

setValue()

virtual void NekScalarValue::setValue ( )

virtual

Instead, we want to have a separate method that we can call from NekRSProblemBase.

usrwrkSlot()

virtual unsigned int NekScalarValue::usrwrkSlot ( ) const

inlinevirtual

validParams()

static InputParameters NekScalarValue::validParams ( )

static

Member Data Documentation

_counter

unsigned int NekScalarValue::_counter

protected

Counter of this object, to be set by NekRSProblem.

_scaling

const Real& NekScalarValue::_scaling

protected

A multiplier to apply to 'value'.

_usrwrk_slot

unsigned int NekScalarValue::_usrwrk_slot

protected

Slot in usrwrk to write the scalar value.

_value

const Real& NekScalarValue::_value

protected

The value to send into NekRS.

---

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

• include/userobjects/NekScalarValue.h