- directionDirection in which to send data
C++ Type:MooseEnum
Controllable:No
Description:Direction in which to send data
NekVolumetricData
Description
NekVolumetricData is a FieldTransfer that sends a general volumetric field between NekRS and MOOSE. For instance, this object can be used to pass an entire volumetric field from the scratch space into NekRS. This object is effectively the same as NekVolumetricSource, except that this latter object is specifically only for heat sources (in which case there is additional normalization applied). This object creates an AuxVariable using the name of the object; this variable will hold the volumetric quantity which NekRS reads (for direction = to_nek) or will be written by NekRS (for direction = from_nek).
Example Input File Syntax
As an example, the example below fills the scratch space slots with auxiliary variables named usrwrk00, usrwrk01, and usrwrk02 and passes these into the scratch space inside NekRS.
[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
type = NekRSProblem
casename<<<{"description": "Case name for the NekRS input files; this is <case> in <case>.par, <case>.udf, <case>.oudf, and <case>.re2."}>>> = 'brick'
n_usrwrk_slots<<<{"description": "If initialize_usrwrk is true, the number of slots that Cardinal will allocate in platform->app->bc->o_usrwrk. These entries can be used to hold fields related to coupling (which will be populated by Cardinal), or other custom usages, such as a distance-to-wall calculation"}>>> = 3
[FieldTransfers<<<{"href": "../../syntax/Problem/FieldTransfers/index.html"}>>>]
[usrwrk00]
type = NekVolumetricData<<<{"description": "Reads/writes volumetric source data between NekRS and MOOSE."}>>>
usrwrk_slot<<<{"description": "When 'direction = to_nek', the slot(s) in the usrwrk array to write the incoming data; provide one entry for each quantity being passed"}>>> = 0
direction<<<{"description": "Direction in which to send data"}>>> = to_nek
[]
[usrwrk01]
type = NekVolumetricData<<<{"description": "Reads/writes volumetric source data between NekRS and MOOSE."}>>>
usrwrk_slot<<<{"description": "When 'direction = to_nek', the slot(s) in the usrwrk array to write the incoming data; provide one entry for each quantity being passed"}>>> = 1
direction<<<{"description": "Direction in which to send data"}>>> = to_nek
[]
[usrwrk02]
type = NekVolumetricData<<<{"description": "Reads/writes volumetric source data between NekRS and MOOSE."}>>>
usrwrk_slot<<<{"description": "When 'direction = to_nek', the slot(s) in the usrwrk array to write the incoming data; provide one entry for each quantity being passed"}>>> = 2
direction<<<{"description": "Direction in which to send data"}>>> = to_nek
[]
[]
[]Input Parameters
- usrwrk_slotWhen 'direction = to_nek', the slot(s) in the usrwrk array to write the incoming data; provide one entry for each quantity being passed
C++ Type:std::vector<unsigned int>
Controllable:No
Description:When 'direction = to_nek', the slot(s) in the usrwrk array to write the incoming data; provide one entry for each quantity being passed
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:No
Description:Set the enabled status of the MooseObject.
Advanced Parameters
Input Files
- (test/tests/nek_file_output/usrwrk/nek.i)
- (test/tests/postprocessors/nek_volume_average/nek.i)
- (test/tests/postprocessors/nek_point_value/points.i)
- (test/tests/postprocessors/nek_volume_integral/nondimensional.i)
- (test/tests/postprocessors/nek_volume_average/nondimensional.i)
- (test/tests/postprocessors/nek_point_value/points_nondimensional.i)
- (test/tests/postprocessors/nek_volume_integral/nek.i)