AMR-Wind  v0.1.0
CFD solver for wind plant simulations
Namespaces | Classes | Typedefs | Enumerations | Functions
amr_wind Namespace Reference

AMR-Wind. More...

Namespaces

 actuator
 
 ascent_int
 
 averaging
 
 burggraf
 
 channel_flow
 
 channel_map
 
 const_map
 
 ctv
 
 derived
 
 diagnostics
 
 enstrophy
 
 field_impl
 
 field_norms
 
 field_ops
 
 free_surface
 
 fvm
 
 gpu
 
 hybrid_rans_les_abl
 
 hydrostatic
 
 ib
 
 interp
 
 io
 
 ioutils
 
 kinetic_energy
 
 mms
 
 multiphase
 
 nodal_projection
 
 ocean_waves
 
 pde
 
 pde_impl
 
 sampling
 
 scalar_bc
 
 synth_turb
 
 tagging
 
 tioga_iface
 
 transport
 
 turbulence
 
 udf
 
 utils
 
 vel_bc
 
 vs
 
 wave_energy
 
 zds
 Multiphase Zalesak disk physics.
 

Classes

class  BCIface
 Abstract class that defines the interface for processing BCs. More...
 
class  BCVelocity
 Boundary condition initialization for velocity (ICNS momentum) field. More...
 
class  BCScalar
 Boundary condition initialization for scalar transport variables. More...
 
class  BCPressure
 Specialization of BC initialization for pressure. More...
 
class  BCSrcTerm
 Specialization for source terms. More...
 
class  BCFillPatchExtrap
 Default BC that can be applied on any field. More...
 
class  FixedGradientBC
 Applies a non-zero gradient at the domain boundary. More...
 
struct  LogLaw
 
struct  SimpleShearSchumann
 
struct  SimpleShearLogLaw
 
class  WallFunction
 Wall-function computations for LES simulations. More...
 
class  VelWallFunc
 Applies a shear-stress value at the domain boundary. More...
 
class  CFDSim
 Data structures for a CFD simulation. More...
 
class  CollMgr
 Interface to manage objects of sub-classes based on factory registration. More...
 
class  ExtSolver
 
class  ExtSolverMgr
 
struct  Factory
 Runtime selection of options based on string keyword lookup. More...
 
struct  FieldInfo
 Information common to a field that has multiple states. More...
 
class  Field
 Computational field. More...
 
class  FieldBCIface
 Interface to setup up boundary conditions on a field. More...
 
struct  FieldBCNoOp
 A no-op BC. More...
 
struct  ConstDirichlet
 
struct  DirichletOp
 Sets constant values on specified boundaries. More...
 
struct  FieldBCDirichlet
 
struct  BCOpCreator
 
class  FieldFillPatchOpsBase
 Abstract interface for classes that handle fill patch and physical boundary condition operations for multi-level AMR meshes. More...
 
class  FieldFillConstScalar
 Implementation that just fills a constant value on newly created grids. More...
 
class  FieldFillPatchOps
 Concrete implementation of filling patches and boundary conditions on multi-level AMR meshes. More...
 
struct  LevelDataHolder
 Object that holds the MultiFab instances at all levels for a given field. More...
 
class  FieldRepo
 Field Repository. More...
 
class  IntField
 An integer computational field. More...
 
class  IntScratchField
 Integer version of ScratchField that works with iMultiFab. More...
 
class  MeshMap
 Abstract representation of different mesh mapping models. More...
 
struct  MLMGOptions
 Interface to control the behavior of AMReX LinearSolvers. More...
 
class  PhysicsOld
 
class  Physics
 Abstract representation of different physics. More...
 
class  PhysicsMgr
 A collection of Physics models instances that are active during a simulation. More...
 
class  ScratchField
 A temporary computational field. More...
 
class  SimTime
 Time manager for simulations. More...
 
class  ViewField
 Subview of a Field or a ScratchField. More...
 
class  BCVOF
 BC interface for VOF. More...
 
class  helics_storage
 
class  OversetManager
 Overset interface manager. More...
 
class  OversetOps
 
struct  AMROversetInfo
 AMR mesh data in TIOGA format. More...
 
class  TiogaInterface
 
class  BoussinesqBubble
 Boussinesq Bubble physics. More...
 
class  BoussinesqBubbleFieldInit
 Initialize BoussinesqBubble fields. More...
 
class  EkmanSpiral
 Ekman Spiral physics. More...
 
class  FreeStream
 Freestream physics. More...
 
class  BreakingWaves
 Numerical Wave Basin physics. More...
 
class  DamBreak
 
class  MultiPhase
 
class  RainDrop
 
class  SloshingTank
 
class  VortexPatch
 
class  VortexPatchScalarVel
 
class  ZalesakDisk
 
class  RayleighTaylor
 Rayleigh Taylor physics. More...
 
class  RayleighTaylorFieldInit
 Initialize RayleighTaylor fields. More...
 
class  ScalarAdvection
 Scalar Advection physics. More...
 
struct  GaussianWavePacket
 
struct  GaussianPulseFV
 
struct  TwoDimGaussianPulseFV
 
struct  SquarePulseFV
 
struct  GaussianWavePacketFV
 
struct  SynthTurbData
 
struct  SynthTurbDeviceData
 
struct  InterpWeights
 Indices and interpolation weights for a given point located within the turbulence box. More...
 
class  SyntheticTurbulence
 
class  TaylorGreenVortex
 Taylor Green Vortex physics. More...
 
class  VortexDipole
 Vortex dipole Physics. More...
 
class  VortexRing
 Vortex ring physics. More...
 
struct  FatCore
 
struct  CollidingRings
 
class  DerivedQty
 
class  DerivedQtyMgr
 
class  FPlaneAveraging
 Output average of a field on planes normal to a given direction. More...
 
class  VelPlaneAveraging
 Specific application of FieldPlaneAveraging to the velocity field. More...
 
class  FPlaneAveragingFine
 Output average of a field on planes normal to a given direction. More...
 
class  VelPlaneAveragingFine
 Specific application of FieldPlaneAveraging to the velocity field. More...
 
class  IOManager
 Input/Output manager. More...
 
class  MultiLevelVector
 Multi-level vector. More...
 
class  PostProcessBase
 Abstract representation of a post-processing utility. More...
 
class  PostProcessManager
 A collection of post-processing instances that are active during a simulation. More...
 
class  SecondMomentAveraging
 Compute second moments for two variables. More...
 
class  CartBoxRefinement
 Static refinement with Cartesian-aligned bounding boxes. More...
 
class  FieldRefinement
 AMR refinement using a given field (e.g., density) More...
 
class  GeometryRefinement
 AMR based on geometric shapes. More...
 
class  OversetRefinement
 
class  QCriterionRefinement
 AMR refinement using Q criterion. More...
 
class  RefinementCriteria
 Abstract interface for tagging cells for refinement. More...
 
class  RefineCriteriaManager
 A collection of refinement criteria instances that are active during a simulation. More...
 
class  VorticityMagRefinement
 AMR refinement using vorticity. More...
 
class  ThirdMomentAveraging
 Compute the third moment with three fields. More...
 
class  ABL
 Atmospheric Boundary Layer physics. More...
 
class  ABLAnelastic
 Interface for ABL anelastic. More...
 
struct  BufferData
 
class  InletData
 Collection of data structures and operations for reading data. More...
 
class  ABLBoundaryPlane
 Interface for ABL boundary plane I/O. More...
 
class  ABLFieldInit
 Initialize ABL fields. More...
 
class  ABLFieldInitFile
 Initialize subset of ABL fields using input NetCDF file. More...
 
class  ABLFillInflow
 Operations to perform inflow of data from boundary planes. More...
 
class  ABLFillMPL
 Operations to perform inflow of data from boundary planes. More...
 
class  ABLMesoscaleForcing
 
class  ABLMesoscaleInput
 
class  ABLModulatedPowerLaw
 Interface for ABL modulated power law. More...
 
class  ABLStats
 
class  ABLStatsBase
 
class  ABLWallFunction
 Wall-function computations for LES simulations of ABL. More...
 
class  ABLVelWallFunc
 Applies a shear-stress value at the domain boundary. More...
 
class  ABLTempWallFunc
 
struct  MOData
 Monin-Obukhov surface layer profile. More...
 
struct  ShearStressConstant
 
struct  ShearStressLocal
 
struct  ShearStressSchumann
 
struct  ShearStressMoeng
 
struct  ShearStressDonelan
 

Typedefs

using FieldPlaneAveraging = FPlaneAveraging< Field >
 
using ScratchFieldPlaneAveraging = FPlaneAveraging< ScratchField >
 
using FieldPlaneAveragingFine = FPlaneAveragingFine< Field >
 
using ScratchFieldPlaneAveragingFine = FPlaneAveragingFine< ScratchField >
 

Enumerations

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

Functions

template<typename FType >
void normalize_field (FType &Field)
 
template void normalize_field< Field > (Field &)
 
template void normalize_field< ScratchField > (ScratchField &)
 
 INSTANTIATE_TURBULENCE_MODEL (Laminar)
 
 INSTANTIATE_TURBULENCE_MODEL (AMD)
 
 INSTANTIATE_TURBULENCE_MODEL (AMDNoTherm)
 
 INSTANTIATE_TURBULENCE_MODEL (Kosovic)
 
 INSTANTIATE_TURBULENCE_MODEL (OneEqKsgsM84)
 
 INSTANTIATE_TURBULENCE_MODEL (OneEqKsgsS94)
 
 INSTANTIATE_TURBULENCE_MODEL (Smagorinsky)
 
 INSTANTIATE_TURBULENCE_MODEL (KOmegaSST)
 
 INSTANTIATE_TURBULENCE_MODEL (KOmegaSSTIDDES)
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int direction_selector (const int i, const int j, const int k, const int dir)
 

Detailed Description

AMR-Wind.

Ascent In-situ Integration.

Multiphase Zalesak disk physics.

Multiphase vortex patch scalar velocity physics.

Multiphase vortex patch physics.

Multiphase Sloshing Tank 3D physics.

Multiphase falling raindrop physics.

Multiphase physics.

Multiphase Dam break physics.

All C++ code in AMR-Wind is organized within the amr_wind namespace.

This class implements the necessary code to simulate multiphase (air-water interaction) problems with AMR-Wind. It reads the namespace ‘MultiPhase’ from the input file to determine how the initial conditions are generated.

This test case is intended as an evaluation of the momentum advection scheme. The cell-centered velocity field is treated as a scalar, initialized as a smooth function crossing the interface. The advection velocities at the faces are prescribed as functions of time and space, and do not depend on the changing cell-centered velocity field.

Typedef Documentation

◆ FieldPlaneAveraging

◆ FieldPlaneAveragingFine

◆ ScratchFieldPlaneAveraging

◆ ScratchFieldPlaneAveragingFine

Enumeration Type Documentation

◆ ABLStatsMode

enum amr_wind::ABLStatsMode : int
strong
Enumerator
computed 
prescribed 

! Computed using planar averages

! Prescribed as user inputs

◆ InterfaceCapturingMethod

Enumerator
VOF 

Volume of fluid.

LS 

Levelset.

◆ io_mode

enum amr_wind::io_mode
strong
Enumerator
output 
input 
undefined 

Function Documentation

◆ direction_selector()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int amr_wind::direction_selector ( const int  i,
const int  j,
const int  k,
const int  dir 
)

◆ INSTANTIATE_TURBULENCE_MODEL() [1/9]

amr_wind::INSTANTIATE_TURBULENCE_MODEL ( AMD  )

◆ INSTANTIATE_TURBULENCE_MODEL() [2/9]

amr_wind::INSTANTIATE_TURBULENCE_MODEL ( AMDNoTherm  )

◆ INSTANTIATE_TURBULENCE_MODEL() [3/9]

amr_wind::INSTANTIATE_TURBULENCE_MODEL ( KOmegaSST  )

◆ INSTANTIATE_TURBULENCE_MODEL() [4/9]

amr_wind::INSTANTIATE_TURBULENCE_MODEL ( KOmegaSSTIDDES  )

◆ INSTANTIATE_TURBULENCE_MODEL() [5/9]

amr_wind::INSTANTIATE_TURBULENCE_MODEL ( Kosovic  )

◆ INSTANTIATE_TURBULENCE_MODEL() [6/9]

amr_wind::INSTANTIATE_TURBULENCE_MODEL ( Laminar  )

◆ INSTANTIATE_TURBULENCE_MODEL() [7/9]

amr_wind::INSTANTIATE_TURBULENCE_MODEL ( OneEqKsgsM84  )

◆ INSTANTIATE_TURBULENCE_MODEL() [8/9]

amr_wind::INSTANTIATE_TURBULENCE_MODEL ( OneEqKsgsS94  )

◆ INSTANTIATE_TURBULENCE_MODEL() [9/9]

amr_wind::INSTANTIATE_TURBULENCE_MODEL ( Smagorinsky  )

◆ normalize_field()

template<typename FType >
void amr_wind::normalize_field ( FType &  Field)

◆ normalize_field< Field >()

template void amr_wind::normalize_field< Field > ( Field )

◆ normalize_field< ScratchField >()