Field management

AMR-Wind API: Field management
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches
Collaboration diagram for Field management:

Topics

 Boundary conditions management
 
 Field operations
 
 Fillpatch operators
 

Classes

struct  amr_wind::FieldInfo
 
class  amr_wind::Field
 
class  amr_wind::FieldRepo
 
class  amr_wind::IntField
 
class  amr_wind::ScratchField
 
class  amr_wind::ViewField< T >
 

Enumerations

enum class  amr_wind::FieldState : int {
  amr_wind::FieldState::NP1 = 0 , amr_wind::FieldState::N , amr_wind::FieldState::NM1 , amr_wind::FieldState::NPH ,
  amr_wind::FieldState::NMH , amr_wind::FieldState::New = NP1 , amr_wind::FieldState::Old = N
}
 
enum class  amr_wind::FieldLoc : int {
  amr_wind::FieldLoc::CELL , amr_wind::FieldLoc::NODE , amr_wind::FieldLoc::XFACE , amr_wind::FieldLoc::YFACE ,
  amr_wind::FieldLoc::ZFACE
}
 
enum class  amr_wind::FieldInterpolator : int {
  amr_wind::FieldInterpolator::PiecewiseConstant , amr_wind::FieldInterpolator::CellConsLinear , amr_wind::FieldInterpolator::NodeBilinear , amr_wind::FieldInterpolator::FaceDivFree ,
  amr_wind::FieldInterpolator::FaceLinear
}
 

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