InletData Class Reference

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

#include <ABLBoundaryPlane.H>

Collaboration diagram for amr_wind::InletData:
[legend]

Public Member Functions

 InletData ()=default
 
void resize (const int)
 
void define_plane (const amrex::Orientation)
 
void define_level_data (const amrex::Orientation, const amrex::Box &, const size_t)
 
void read_data (ncutils::NCGroup &, const amrex::Orientation, const int, const Field *, const amrex::Real, const amrex::Vector< amrex::Real > &)
 
void read_data_native (const amrex::OrientationIter oit, amrex::BndryRegister &bndry_n, amrex::BndryRegister &bndry_np1, const int lev, const Field *, const amrex::Real time, const amrex::Vector< amrex::Real > &)
 
void interpolate (const amrex::Real)
 
bool is_populated (amrex::Orientation) const
 
const amrex::FArrayBox & interpolate_data (const amrex::Orientation ori, const int lev) const
 
int & component (const int id)
 
int component (const int id) const
 
int nlevels (const amrex::Orientation ori) const
 
amrex::Real tn () const
 
amrex::Real tnp1 () const
 
amrex::Real tinterp () const
 

Private Types

using PlaneVector = amrex::Vector<amrex::FArrayBox>
 

Private Attributes

amrex::Vector< std::unique_ptr< PlaneVector > > m_data_n
 
amrex::Vector< std::unique_ptr< PlaneVector > > m_data_np1
 
amrex::Vector< std::unique_ptr< PlaneVector > > m_data_interp
 
amrex::Real m_tn {-1.0}
 Time for plane at n.
 
amrex::Real m_tnp1 {-1.0}
 Time for plane at n + 1.
 
amrex::Real m_tinterp {-1.0}
 Time for plane at interpolation.
 
std::unordered_map< int, int > m_components
 Map of {variableId : component}
 

Detailed Description

Collection of data structures and operations for reading data

This class contains the inlet data structures and operations to read and interpolate inflow data.

Member Typedef Documentation

◆ PlaneVector

using amr_wind::InletData::PlaneVector = amrex::Vector<amrex::FArrayBox>
private

Constructor & Destructor Documentation

◆ InletData()

amr_wind::InletData::InletData ( )
default

Member Function Documentation

◆ component() [1/2]

int & amr_wind::InletData::component ( const int id)
inline

◆ component() [2/2]

int amr_wind::InletData::component ( const int id) const
inline

◆ define_level_data()

void amr_wind::InletData::define_level_data ( const amrex::Orientation ori,
const amrex::Box & bx,
const size_t nc )

◆ define_plane()

void amr_wind::InletData::define_plane ( const amrex::Orientation ori)

◆ interpolate()

void amr_wind::InletData::interpolate ( const amrex::Real time)

◆ interpolate_data()

const amrex::FArrayBox & amr_wind::InletData::interpolate_data ( const amrex::Orientation ori,
const int lev ) const
inline

◆ is_populated()

bool amr_wind::InletData::is_populated ( amrex::Orientation ori) const

◆ nlevels()

int amr_wind::InletData::nlevels ( const amrex::Orientation ori) const
inline

◆ read_data()

void amr_wind::InletData::read_data ( ncutils::NCGroup & grp,
const amrex::Orientation ori,
const int lev,
const Field * fld,
const amrex::Real time,
const amrex::Vector< amrex::Real > & times )

◆ read_data_native()

void amr_wind::InletData::read_data_native ( const amrex::OrientationIter oit,
amrex::BndryRegister & bndry_n,
amrex::BndryRegister & bndry_np1,
const int lev,
const Field * fld,
const amrex::Real time,
const amrex::Vector< amrex::Real > & times )

◆ resize()

void amr_wind::InletData::resize ( const int size)

◆ tinterp()

amrex::Real amr_wind::InletData::tinterp ( ) const
inline

◆ tn()

amrex::Real amr_wind::InletData::tn ( ) const
inline

◆ tnp1()

amrex::Real amr_wind::InletData::tnp1 ( ) const
inline

Member Data Documentation

◆ m_components

std::unordered_map<int, int> amr_wind::InletData::m_components
private

Map of {variableId : component}

◆ m_data_interp

amrex::Vector<std::unique_ptr<PlaneVector> > amr_wind::InletData::m_data_interp
private

◆ m_data_n

amrex::Vector<std::unique_ptr<PlaneVector> > amr_wind::InletData::m_data_n
private

◆ m_data_np1

amrex::Vector<std::unique_ptr<PlaneVector> > amr_wind::InletData::m_data_np1
private

◆ m_tinterp

amrex::Real amr_wind::InletData::m_tinterp {-1.0}
private

Time for plane at interpolation.

◆ m_tn

amrex::Real amr_wind::InletData::m_tn {-1.0}
private

Time for plane at n.

◆ m_tnp1

amrex::Real amr_wind::InletData::m_tnp1 {-1.0}
private

Time for plane at n + 1.


The documentation for this class was generated from the following files: