#include <NekBoundaryFlux.h>

Inheritance diagram for NekBoundaryFlux:

Public Member Functions
	NekBoundaryFlux (const InputParameters &parameters)

virtual void	sendDataToNek () override
	Send data to Nek. More...

virtual void	readDataFromNek () override
	Read data from Nek. More...

const MooseEnum &	direction () const
	Get the direction of the transfer. More...

Static Public Member Functions
static InputParameters	validParams ()

static std::map< unsigned int, std::string >	usrwrkMap ()

Protected Member Functions
void	checkInitialFluxValues (const Real &nek_flux, const Real &moose_flux) const

bool	normalizeFlux (const double moose_integral, double nek_integral, double &normalized_nek_integral)

bool	normalizeFluxBySideset (const std::vector< double > &moose_integral, std::vector< double > &nek_integral, double &normalized_nek_integral)

std::string	normalizationHint () const

void	fillAuxVariable (const unsigned int var_number, const double *value)

void	addExternalVariable (const std::string name)

void	addExternalVariable (const unsigned int slot, const std::string name)

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

void	checkAllocatedUsrwrkSlot (const unsigned int &u) const

Protected Attributes
const bool &	_conserve_flux_by_sideset

const Real &	_initial_flux_integral
	Initial value to use for the total flux integral for ensuring conservation. More...

const std::vector< int > *	_boundary
	Boundaries through which the flux transfer occurs. More...

const Real	_reference_flux_integral
	Dimensional reference flux, computed from characteristic scales. More...

const PostprocessorValue *	_flux_integral = nullptr
	Total surface-integrated flux coming from the coupled MOOSE app. More...

const VectorPostprocessorValue *	_flux_integral_vpp = nullptr
	Sideset-wise surface-integrated flux coming from the coupled MOOSE app. More...

const Real &	_abs_tol
	Absolute tolerance for checking conservation. More...

const Real &	_rel_tol
	Relative tolerance for checking conservation. More...

std::string	_postprocessor_name
	Name of the postprocessor/vectorpostprocessor used to apply conservation. More...

std::string	_variable
	Variable name (or prefix of names) to create in MOOSE to facilitate data passing. More...

std::vector< unsigned int >	_usrwrk_slot
	Slot in usrwrk array to use for writing data, if 'direction = to_nek'. More...

std::map< std::string, unsigned int >	_variable_number
	Internal number for the variable(s) created in MOOSE (name, number) More...

int	_n_per_surf
	Number of points on the MOOSE mesh to write per element surface. More...

int	_n_per_vol
	Number of points on the MOOSE mesh to write per element volume. More...

double *	_v_face = nullptr
	MOOSE data interpolated onto the (boundary) data transfer mesh. More...

double *	_v_elem = nullptr
	MOOSE data interpolated onto the (volume) data transfer mesh. More...

double *	_external_data = nullptr
	Scratch space to place external NekRS fields before writing into auxiliary variables. More...

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

Static Protected Attributes
static std::map< unsigned int, std::string >	_field_usrwrk_map

Detailed Description

Performs a transfer of a boundary flux between NekRS and MOOSE. The mesh used for the MOOSE app may be very different from the mesh used by nekRS. Elements may be much finer/coarser, and one element on the MOOSE app may not be a clear subset/superset of the elements on the nekRS mesh. Therefore, to ensure conservation, we send the flux integrals (either for all sidesets lumped together or on a per-sideset basis) to nekRS for internal normalization of the flux applied on the nekRS mesh.

Constructor & Destructor Documentation

◆ NekBoundaryFlux()

NekBoundaryFlux::NekBoundaryFlux ( const InputParameters & parameters )

Member Function Documentation

◆ addExternalPostprocessor()

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

protectedinherited

Add a postprocessor to facilitate coupling

Parameters

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

◆ addExternalVariable() [1/2]

void FieldTransferBase::addExternalVariable ( const std::string name )

protectedinherited

Add a MOOSE variable to facilitate coupling

Parameters

[in] name variable name

◆ addExternalVariable() [2/2]

void FieldTransferBase::addExternalVariable	(	const unsigned int	slot,
		const std::string	name
	)

protectedinherited

Add a MOOSE variable to facilitate coupling

Parameters

[in]	slot	slot in usrwrk array holding this field
[in]	name	variable name

◆ checkAllocatedUsrwrkSlot()

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

protectedinherited

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

Parameters

[in] u slice in usrwrk array

◆ checkInitialFluxValues()

void NekBoundaryFlux::checkInitialFluxValues	(	const Real &	nek_flux,
		const Real &	moose_flux
	)		const

protected

Print a warning to the user if the initial fluxes (before normalization) differ significantly, since this can (but not always) indicate an error with model setup.

Parameters

[in]	nek_flux	flux to be received by Nek
[in]	moose_flux	flux sent by MOOSE

◆ direction()

const MooseEnum& NekTransferBase::direction ( ) const

inlineinherited

Get the direction of the transfer.

◆ fillAuxVariable()

void FieldTransferBase::fillAuxVariable	(	const unsigned int	var_number,
		const double *	value
	)

protectedinherited

Fill an outgoing auxiliary variable field with nekRS solution data

Parameters

[in]	var_number	auxiliary variable number
[in]	value	nekRS solution data to fill the variable with

◆ normalizationHint()

std::string ConservativeFieldTransfer::normalizationHint ( ) const

protectedinherited

Return a string to print in error messages upon failed normalizations

Returns: debugging hint

◆ normalizeFlux()

bool NekBoundaryFlux::normalizeFlux	(	const double	moose_integral,
		double	nek_integral,
		double &	normalized_nek_integral
	)

protected

Normalize the flux sent to nekRS to conserve the total flux

Parameters

[in]	moose_integral	total integrated flux from MOOSE to conserve
[in]	nek_integral	total integrated flux in nekRS to adjust
[out]	normalized_nek_integral	final normalized nek flux integral

Returns: whether normalization was successful, i.e. normalized_nek_integral equals moose_integral

◆ normalizeFluxBySideset()

bool NekBoundaryFlux::normalizeFluxBySideset	(	const std::vector< double > &	moose_integral,
		std::vector< double > &	nek_integral,
		double &	normalized_nek_integral
	)

protected

Normalize the flux sent to nekRS to conserve the total flux

Parameters

[in]	moose_integral	total integrated flux from MOOSE to conserve
[in]	nek_integral	total integrated flux in nekRS to adjust
[out]	normalized_nek_integral	final normalized nek flux integral

Returns: whether normalization was successful, i.e. normalized_nek_integral equals moose_integral

◆ readDataFromNek()

virtual void NekBoundaryFlux::readDataFromNek ( )

overridevirtual

Read data from Nek.

Reimplemented from NekTransferBase.

◆ sendDataToNek()

virtual void NekBoundaryFlux::sendDataToNek ( )

overridevirtual

Send data to Nek.

Reimplemented from NekTransferBase.

◆ usrwrkMap()

static std::map<unsigned int, std::string> FieldTransferBase::usrwrkMap ( )

inlinestaticinherited

Get the mapping of usrwrk slots to variable names for all field transfers

Returns: map ordered as (slot number, name)

◆ validParams()

static InputParameters NekBoundaryFlux::validParams ( )

static

Member Data Documentation

◆ _abs_tol

const Real& ConservativeFieldTransfer::_abs_tol

protectedinherited

Absolute tolerance for checking conservation.

◆ _boundary

const std::vector<int>* NekBoundaryFlux::_boundary

protected

Boundaries through which the flux transfer occurs.

◆ _conserve_flux_by_sideset

const bool& NekBoundaryFlux::_conserve_flux_by_sideset

protected

Whether to conserve flux received in NekRS by individually re-normalizing with integrals over individual sideset. This approach is technically more accurate, but places limitations on how the sidesets are defined (they should NOT share any nodes with one another) and more effort with vector postprocessors, so it is not the default.

◆ _direction

const MooseEnum& NekTransferBase::_direction

protectedinherited

Direction of the transfer.

◆ _external_data

double* FieldTransferBase::_external_data = nullptr

protectedinherited

Scratch space to place external NekRS fields before writing into auxiliary variables.

◆ _field_usrwrk_map

std::map<unsigned int, std::string> FieldTransferBase::_field_usrwrk_map

staticprotectedinherited

Information about data stored in the usrwrk array for error checking and diagnostics; stored as (slot, variable name in MOOSE)

◆ _flux_integral

const PostprocessorValue* NekBoundaryFlux::_flux_integral = nullptr

protected

Total surface-integrated flux coming from the coupled MOOSE app.

◆ _flux_integral_vpp

const VectorPostprocessorValue* NekBoundaryFlux::_flux_integral_vpp = nullptr

protected

Sideset-wise surface-integrated flux coming from the coupled MOOSE app.

◆ _initial_flux_integral

const Real& NekBoundaryFlux::_initial_flux_integral

protected

Initial value to use for the total flux integral for ensuring conservation.

◆ _n_per_surf

int FieldTransferBase::_n_per_surf

protectedinherited

Number of points on the MOOSE mesh to write per element surface.

◆ _n_per_vol

int FieldTransferBase::_n_per_vol

protectedinherited

Number of points on the MOOSE mesh to write per element volume.

◆ _nek_mesh

NekRSMesh* NekTransferBase::_nek_mesh

protectedinherited

The underlying NekRSMesh mirror.

◆ _nek_problem

NekRSProblem& NekTransferBase::_nek_problem

protectedinherited

The NekRSProblem using the field transfer interface.

◆ _postprocessor_name

std::string ConservativeFieldTransfer::_postprocessor_name

protectedinherited

Name of the postprocessor/vectorpostprocessor used to apply conservation.

◆ _reference_flux_integral

const Real NekBoundaryFlux::_reference_flux_integral

protected

Dimensional reference flux, computed from characteristic scales.

◆ _rel_tol

const Real& ConservativeFieldTransfer::_rel_tol

protectedinherited

Relative tolerance for checking conservation.

◆ _usrwrk_slot

std::vector<unsigned int> FieldTransferBase::_usrwrk_slot

protectedinherited

Slot in usrwrk array to use for writing data, if 'direction = to_nek'.

◆ _v_elem

double* FieldTransferBase::_v_elem = nullptr

protectedinherited

MOOSE data interpolated onto the (volume) data transfer mesh.

◆ _v_face

double* FieldTransferBase::_v_face = nullptr

protectedinherited

MOOSE data interpolated onto the (boundary) data transfer mesh.

◆ _variable

std::string FieldTransferBase::_variable

protectedinherited

Variable name (or prefix of names) to create in MOOSE to facilitate data passing.

◆ _variable_number

std::map<std::string, unsigned int> FieldTransferBase::_variable_number

protectedinherited

Internal number for the variable(s) created in MOOSE (name, number)

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

include/transfers/NekBoundaryFlux.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NekBoundaryFlux()

Member Function Documentation

◆ addExternalPostprocessor()

◆ addExternalVariable() [1/2]

◆ addExternalVariable() [2/2]

◆ checkAllocatedUsrwrkSlot()

◆ checkInitialFluxValues()

◆ direction()

◆ fillAuxVariable()

◆ normalizationHint()

◆ normalizeFlux()

◆ normalizeFluxBySideset()

◆ readDataFromNek()

◆ sendDataToNek()

◆ usrwrkMap()

◆ validParams()

Member Data Documentation

◆ _abs_tol

◆ _boundary

◆ _conserve_flux_by_sideset

◆ _direction

◆ _external_data

◆ _field_usrwrk_map

◆ _flux_integral

◆ _flux_integral_vpp

◆ _initial_flux_integral

◆ _n_per_surf

◆ _n_per_vol

◆ _nek_mesh

◆ _nek_problem

◆ _postprocessor_name

◆ _reference_flux_integral

◆ _rel_tol

◆ _usrwrk_slot

◆ _v_elem

◆ _v_face

◆ _variable

◆ _variable_number