NekTransferBase Class Reference

#include <NekTransferBase.h>

Inheritance diagram for NekTransferBase:

Public Member Functions
	NekTransferBase (const InputParameters &parameters)
virtual void	sendDataToNek ()
	Send data to Nek. More...
virtual void	readDataFromNek ()
	Read data from Nek. More...
const MooseEnum &	direction () const
	Get the direction of the transfer. More...

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
void	addExternalPostprocessor (const std::string name, const Real initial)
void	checkAllocatedUsrwrkSlot (const unsigned int &u) const

Protected Attributes
NekRSProblem &	_nek_problem
	The NekRSProblem using the field transfer interface. More...
NekRSMesh *	_nek_mesh
	The underlying NekRSMesh mirror. More...
const MooseEnum &	_direction
	Direction of the transfer. More...

Detailed Description

Base class for facilitating a data transfer between MOOSE and the NekRS code internals.

Constructor & Destructor Documentation

NekTransferBase()

NekTransferBase::NekTransferBase

(

const InputParameters &

parameters

)

Member Function Documentation

addExternalPostprocessor()

void NekTransferBase::addExternalPostprocessor ( const std::string  name, const Real  initial  )

protected

Add a postprocessor to facilitate coupling

Parameters

[in]	name	postprocessor name
[in]	initial	initial value to use for the postprocessor

checkAllocatedUsrwrkSlot()

void NekTransferBase::checkAllocatedUsrwrkSlot ( const unsigned int &  u ) const

protected

Check if a specified slot in the usrwrk array has been allocated

Parameters

[in]

u

slice in usrwrk array

direction()

const MooseEnum& NekTransferBase::direction ( ) const

inline

Get the direction of the transfer.

readDataFromNek()

virtual void NekTransferBase::readDataFromNek ( )

inlinevirtual

Read data from Nek.

Reimplemented in NekBoundaryFlux, and NekFieldVariable.

sendDataToNek()

virtual void NekTransferBase::sendDataToNek ( )

inlinevirtual

Send data to Nek.

Reimplemented in NekBoundaryFlux, NekVolumetricSource, NekFieldVariable, NekMeshDeformation, NekPostprocessorValue, and NekScalarValue.

validParams()

static InputParameters NekTransferBase::validParams ( )

static

Member Data Documentation

_direction

const MooseEnum& NekTransferBase::_direction

protected

Direction of the transfer.

_nek_mesh

NekRSMesh* NekTransferBase::_nek_mesh

protected

The underlying NekRSMesh mirror.

_nek_problem

NekRSProblem& NekTransferBase::_nek_problem

protected

The NekRSProblem using the field transfer interface.

---

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

• include/transfers/NekTransferBase.h