Field management

Field management infrastructure. More...

Collaboration diagram for Field management:

Modules
	Boundary conditions management
	Boundary conditions management.
	Field operations
	Operators for manipulating fields and computing derived quantities.
	Fillpatch operators
	Field fillpatch operators.

Classes
struct	amr_wind::FieldInfo
	Information common to a field that has multiple states. More...
class	amr_wind::Field
	Computational field. More...
class	amr_wind::FieldRepo
	Field Repository. More...
class	amr_wind::IntField
	An integer computational field. More...
class	amr_wind::ScratchField
	A temporary computational field. More...
class	amr_wind::ViewField< T >
	Subview of a Field or a ScratchField. More...

Enumerations
enum class	amr_wind::FieldState : int {   amr_wind::NP1 = 0 , amr_wind::N , amr_wind::NM1 , amr_wind::NPH ,   amr_wind::NMH , amr_wind::New = NP1 , amr_wind::Old = N }
	Possible time states for a given Field instance. More...
enum class	amr_wind::FieldLoc : int {   amr_wind::CELL , amr_wind::NODE , amr_wind::XFACE , amr_wind::YFACE ,   amr_wind::ZFACE }
	Possible locations for a field in a structured mesh. More...
enum class	amr_wind::FieldInterpolator : int {   amr_wind::PiecewiseConstant , amr_wind::CellConsLinear , amr_wind::NodeBilinear , amr_wind::FaceDivFree ,   amr_wind::FaceLinear }
	Coarse-to-fine field interpolation options. More...

Detailed Description

Field management infrastructure.

Field is at the core of AMR-Wind implementation that handles all the data used during the simulation. FieldRepo manages a collection of fields and is responsible for all memory allocation and reinitialization during regrid process. Field provides a higher-level interface than MultiFabs and also provides a unified interface to manage boundary conditions and states.

Enumeration Type Documentation

FieldInterpolator

enum amr_wind::FieldInterpolator : int

strong

Coarse-to-fine field interpolation options.

Enumerator
PiecewiseConstant	Constant across cell.
CellConsLinear	Linear interpolation.
NodeBilinear	Bilinear nodal interpolation.
FaceDivFree	Divergence free face interpolation.
FaceLinear	Linear face interpolation.

FieldLoc

enum amr_wind::FieldLoc : int

strong

Possible locations for a field in a structured mesh.

Enumerator
CELL	Cell-centered (default)
NODE	Node-centered (e.g., for pressure)
XFACE	Face-centered in x-direction (e.g., face normal velocity)
YFACE	Face-centered in y-direction.
ZFACE	Face-centered in z-direction.

FieldState

enum amr_wind::FieldState : int

strong

Possible time states for a given Field instance.

All defined fields have at least one state, New, as their default state. For state variables, there are currently two states New and Old. Old . indicates the latest solution and New indicates the solution at the next timestep the solution will advance to.

Enumerator
NP1	Latest state, also aliased to New
N	Previous state, also aliased to Old
NM1	State at (n - 1) th timestep.
NPH	State at (n + 1/2) (intermediate) timestep.
NMH	State at (n - 1/2) timestep.
New	Same as FieldState::NP1.
Old	Same as FieldState::N.