TransportModel Class Reference

AMR-Wind API: amr_wind::transport::TransportModel Class Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations

#include <TransportModel.H>

Inheritance diagram for amr_wind::transport::TransportModel:
[legend]
Collaboration diagram for amr_wind::transport::TransportModel:
[legend]

Public Member Functions

 ~TransportModel () override=default
 
virtual std::unique_ptr< ScratchFieldmu ()=0
 Dynamic laminar viscosity (kg/m/s)
 
virtual std::unique_ptr< ScratchFieldalpha ()=0
 Thermal diffusivity.
 
virtual std::unique_ptr< ScratchFieldscalar_diffusivity (const std::string &scalar_name)=0
 Scalar diffusivity based on Schmidt number.
 
virtual std::unique_ptr< ScratchFieldbeta () const =0
 Thermal expansion coefficient.
 
virtual void beta_impl (const int lev, const amrex::MFIter &mfi, const amrex::Box &bx, const amrex::Array4< amrex::Real > &beta) const =0
 Thermal expansion coefficient.
 
virtual amrex::Real reference_temperature () const =0
 Reference temperature.
 
virtual void ref_theta_impl (const int lev, const amrex::MFIter &mfi, const amrex::Box &bx, const amrex::Array4< amrex::Real > &ref_theta) const =0
 Reference temperature.
 
virtual std::unique_ptr< ScratchFieldref_theta () const =0
 Reference temperature.
 
- Public Member Functions inherited from amr_wind::Factory< TransportModel, const CFDSim & >
virtual ~Factory ()=default
 

Static Public Member Functions

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

Protected Attributes

const int m_ngrow {1}
 

Additional Inherited Members

- Public Attributes inherited from amr_wind::Factory< TransportModel, const CFDSim & >
friend Base
 

Detailed Description

Abstract representation of a transport model

Constructor & Destructor Documentation

◆ ~TransportModel()

amr_wind::transport::TransportModel::~TransportModel ( )
overridedefault

Member Function Documentation

◆ alpha()

virtual std::unique_ptr< ScratchField > amr_wind::transport::TransportModel::alpha ( )
pure virtual

Thermal diffusivity.

◆ base_identifier()

static std::string amr_wind::transport::TransportModel::base_identifier ( )
inlinestatic

◆ beta()

virtual std::unique_ptr< ScratchField > amr_wind::transport::TransportModel::beta ( ) const
pure virtual

Thermal expansion coefficient.

◆ beta_impl()

virtual void amr_wind::transport::TransportModel::beta_impl ( const int lev,
const amrex::MFIter & mfi,
const amrex::Box & bx,
const amrex::Array4< amrex::Real > & beta ) const
pure virtual

Thermal expansion coefficient.

◆ mu()

virtual std::unique_ptr< ScratchField > amr_wind::transport::TransportModel::mu ( )
pure virtual

Dynamic laminar viscosity (kg/m/s)

◆ ref_theta()

virtual std::unique_ptr< ScratchField > amr_wind::transport::TransportModel::ref_theta ( ) const
pure virtual

Reference temperature.

◆ ref_theta_impl()

virtual void amr_wind::transport::TransportModel::ref_theta_impl ( const int lev,
const amrex::MFIter & mfi,
const amrex::Box & bx,
const amrex::Array4< amrex::Real > & ref_theta ) const
pure virtual

Reference temperature.

◆ reference_temperature()

virtual amrex::Real amr_wind::transport::TransportModel::reference_temperature ( ) const
pure virtual

Reference temperature.

◆ scalar_diffusivity()

virtual std::unique_ptr< ScratchField > amr_wind::transport::TransportModel::scalar_diffusivity ( const std::string & scalar_name)
pure virtual

Scalar diffusivity based on Schmidt number.

Member Data Documentation

◆ m_ngrow

const int amr_wind::transport::TransportModel::m_ngrow {1}
protected

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