ABLStatsBase Class Reference

AMR-Wind API: amr_wind::ABLStatsBase Class Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches
amr_wind::ABLStatsBase Class Referenceabstract

#include <ABLStatsBase.H>

Inheritance diagram for amr_wind::ABLStatsBase:
[legend]
Collaboration diagram for amr_wind::ABLStatsBase:
[legend]

Public Member Functions

 ABLStatsBase ()=default
 
 ~ABLStatsBase () override=default
 
virtual ABLStatsMode abl_mode () const =0
 Flag indicating ABL simulation mode.
 
virtual const VelPlaneAveragingvel_profile_coarse () const =0
 Interpolating object for vertical velocity profile.
 
virtual const VelPlaneAveragingFinevel_profile () const =0
 
virtual const FieldPlaneAveragingtheta_profile () const =0
 Interpolating object for vertical temperature profile.
 
virtual const FieldPlaneAveragingFinetheta_profile_fine () const =0
 
virtual void post_init_actions ()=0
 Perform initialization actions after the mesh has been created.
 
virtual void pre_advance_work ()=0
 Perform actions at the beginning of a timestep.
 
virtual void post_advance_work ()=0
 Perform actions at the end of a timestep.
 
virtual void register_forcing_term (pde::icns::ABLForcing *forcing) const =0
 
virtual void register_meso_mom_forcing (pde::icns::ABLMesoForcingMom *forcing) const =0
 
virtual void register_meso_temp_forcing (pde::temperature::ABLMesoForcingTemp *forcing) const =0
 
- Public Member Functions inherited from amr_wind::Factory< ABLStatsBase, CFDSim &, ABLWallFunction &, int >
virtual ~Factory ()=default
 

Static Public Member Functions

static std::string base_identifier ()
 
- Static Public Member Functions inherited from amr_wind::Factory< ABLStatsBase, CFDSim &, ABLWallFunction &, int >
static std::unique_ptr< ABLStatsBasecreate (const std::string &key, Args... args)
 
static void print (std::ostream &os)
 

Additional Inherited Members

- Public Attributes inherited from amr_wind::Factory< ABLStatsBase, CFDSim &, ABLWallFunction &, int >
friend Base
 

Constructor & Destructor Documentation

◆ ABLStatsBase()

amr_wind::ABLStatsBase::ABLStatsBase ( )
default

◆ ~ABLStatsBase()

amr_wind::ABLStatsBase::~ABLStatsBase ( )
overridedefault

Member Function Documentation

◆ abl_mode()

virtual ABLStatsMode amr_wind::ABLStatsBase::abl_mode ( ) const
pure virtual

Flag indicating ABL simulation mode.

◆ base_identifier()

static std::string amr_wind::ABLStatsBase::base_identifier ( )
inlinestatic

◆ post_advance_work()

virtual void amr_wind::ABLStatsBase::post_advance_work ( )
pure virtual

Perform actions at the end of a timestep.

◆ post_init_actions()

virtual void amr_wind::ABLStatsBase::post_init_actions ( )
pure virtual

Perform initialization actions after the mesh has been created.

◆ pre_advance_work()

virtual void amr_wind::ABLStatsBase::pre_advance_work ( )
pure virtual

Perform actions at the beginning of a timestep.

◆ register_forcing_term()

virtual void amr_wind::ABLStatsBase::register_forcing_term ( pde::icns::ABLForcing * forcing) const
pure virtual

◆ register_meso_mom_forcing()

virtual void amr_wind::ABLStatsBase::register_meso_mom_forcing ( pde::icns::ABLMesoForcingMom * forcing) const
pure virtual

◆ register_meso_temp_forcing()

virtual void amr_wind::ABLStatsBase::register_meso_temp_forcing ( pde::temperature::ABLMesoForcingTemp * forcing) const
pure virtual

◆ theta_profile()

virtual const FieldPlaneAveraging & amr_wind::ABLStatsBase::theta_profile ( ) const
pure virtual

Interpolating object for vertical temperature profile.

◆ theta_profile_fine()

virtual const FieldPlaneAveragingFine & amr_wind::ABLStatsBase::theta_profile_fine ( ) const
pure virtual

◆ vel_profile()

virtual const VelPlaneAveragingFine & amr_wind::ABLStatsBase::vel_profile ( ) const
pure virtual

◆ vel_profile_coarse()

virtual const VelPlaneAveraging & amr_wind::ABLStatsBase::vel_profile_coarse ( ) const
pure virtual

Interpolating object for vertical velocity profile.


The documentation for this class was generated from the following file:
  • /home/runner/work/amr-wind/amr-wind/amr-wind/wind_energy/ABLStatsBase.H