BoundaryPlane Class Reference

AMR-Wind API: amr_wind::BoundaryPlane Class Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
amr_wind::BoundaryPlane Class Reference
Physics models » Wind energy modeling » ABL

#include <BoundaryPlane.H>

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

Public Member Functions

 BoundaryPlane (CFDSim &)
void post_init_actions () override
void pre_advance_work () override
void post_advance_work () override
void pre_predictor_work () override
void set_velocity (int lev, amrex::Real time, const Field &fld, amrex::MultiFab &mfab, int dcomp=0, int orig_comp=0) const override
void pre_advance_inner_calls ()
void initialize_data ()
void write_header ()
void write_bndry_native_header (const std::string &chkname)
void write_file ()
void read_header ()
amrex::Vector< amrex::BoxArray > read_bndry_native_boxarrays (const std::string &chkname, const Field &field) const
void read_file (bool)
void populate_data (int, amrex::Real, const Field &, amrex::MultiFab &, int dcomp=0, int orig_comp=0) const
bool box_intersects_boundary (const amrex::Box &, int, amrex::Orientation) const
 True if box intersects the boundary.
bool is_data_newer_than (const amrex::Real time) const
io_mode mode () const
MultiBlockContainer * mbc ()

Static Public Member Functions

static std::string identifier ()
static void impl_buffer_field (const amrex::Box &, const int, const int, const amrex::GpuArray< int, 2 > &, const amrex::IntVect &, const amrex::Array4< const amrex::Real > &, amrex::Gpu::ManagedVector< amrex::Real > &)

Private Member Functions

void write_data (const ncutils::NCGroup &grp, const amrex::Orientation, const int, const Field *)
int boundary_native_file_levels () const

Private Attributes

const amr_wind::SimTime & m_time
const FieldRepo & m_repo
const amrex::AmrCore & m_mesh
MultiBlockContainer ** m_mbc
ReadERFFunction * m_read_erf {nullptr}
std::string m_title {"ABL boundary planes"}
int m_write_frequency {1}
 Normal direction for the boundary plane.
amrex::Vector< std::string > m_plane_names
 Plane names.
amrex::Vector< std::string > m_planes
 IO boundary planes.
amrex::Real m_out_start_time {0.0_rt}
 Start outputting after this time.
size_t m_out_counter {0}
 NetCDF time output counter.
std::string m_filename
 File name for IO.
std::string m_time_file
 File name for Native time file.
amrex::Vector< std::string > m_var_names
 Variables for IO.
amrex::Vector< Field * > m_fields
 List of fields for IO.
amrex::Vector< amrex::Real > m_in_times
 NetCDF input level time.
amrex::Vector< int > m_in_timesteps
InletData m_in_data
 Inlet data.
io_mode m_io_mode {io_mode::undefined}
 IO mode.
bool m_has_overset {false}
 Flag indicating if the simulation is overset – needed for complicated timing of pre_advance_work.
const int m_in_rad = 1
 controls extents on native bndry output
const int m_out_rad = 1
const int m_extent_rad = 0
std::string m_out_fmt {"native"}
 output format for bndry output

Detailed Description

Interface for ABL boundary plane I/O

This class performs the necessary file operations to read and write boundary planes.

See also
PlaneFillInflow

Constructor & Destructor Documentation

◆ BoundaryPlane()

amr_wind::BoundaryPlane::BoundaryPlane ( CFDSim & sim)
explicit

Member Function Documentation

◆ boundary_native_file_levels()

int amr_wind::BoundaryPlane::boundary_native_file_levels ( ) const
nodiscardprivate

◆ box_intersects_boundary()

bool amr_wind::BoundaryPlane::box_intersects_boundary ( const amrex::Box & bx,
int lev,
amrex::Orientation ori ) const
nodiscard

True if box intersects the boundary.

◆ identifier()

std::string amr_wind::BoundaryPlane::identifier ( )
inlinestatic

◆ impl_buffer_field()

void amr_wind::BoundaryPlane::impl_buffer_field ( const amrex::Box & bx,
const int n1,
const int nc,
const amrex::GpuArray< int, 2 > & perp,
const amrex::IntVect & v_offset,
const amrex::Array4< const amrex::Real > & fld,
amrex::Gpu::ManagedVector< amrex::Real > & buffer )
static

◆ initialize_data()

void amr_wind::BoundaryPlane::initialize_data ( )

◆ is_data_newer_than()

bool amr_wind::BoundaryPlane::is_data_newer_than ( const amrex::Real time) const
inlinenodiscard

◆ mbc()

MultiBlockContainer * amr_wind::BoundaryPlane::mbc ( )
inline

◆ mode()

io_mode amr_wind::BoundaryPlane::mode ( ) const
inlinenodiscard

◆ populate_data()

void amr_wind::BoundaryPlane::populate_data ( int lev,
amrex::Real time,
const Field & fld,
amrex::MultiFab & mfab,
int dcomp = 0,
int orig_comp = 0 ) const

◆ post_advance_work()

void amr_wind::BoundaryPlane::post_advance_work ( )
override

◆ post_init_actions()

void amr_wind::BoundaryPlane::post_init_actions ( )
override

◆ pre_advance_inner_calls()

void amr_wind::BoundaryPlane::pre_advance_inner_calls ( )

◆ pre_advance_work()

void amr_wind::BoundaryPlane::pre_advance_work ( )
override

◆ pre_predictor_work()

void amr_wind::BoundaryPlane::pre_predictor_work ( )
override

◆ read_bndry_native_boxarrays()

amrex::Vector< amrex::BoxArray > amr_wind::BoundaryPlane::read_bndry_native_boxarrays ( const std::string & chkname,
const Field & field ) const
nodiscard

◆ read_file()

void amr_wind::BoundaryPlane::read_file ( bool nph_target_time)

◆ read_header()

void amr_wind::BoundaryPlane::read_header ( )

◆ set_velocity()

void amr_wind::BoundaryPlane::set_velocity ( int lev,
amrex::Real time,
const Field & fld,
amrex::MultiFab & mfab,
int dcomp = 0,
int orig_comp = 0 ) const
override

◆ write_bndry_native_header()

void amr_wind::BoundaryPlane::write_bndry_native_header ( const std::string & chkname)

◆ write_data()

void amr_wind::BoundaryPlane::write_data ( const ncutils::NCGroup & grp,
const amrex::Orientation ori,
const int lev,
const Field * fld )
private

◆ write_file()

void amr_wind::BoundaryPlane::write_file ( )

◆ write_header()

void amr_wind::BoundaryPlane::write_header ( )

Member Data Documentation

◆ m_extent_rad

const int amr_wind::BoundaryPlane::m_extent_rad = 0
private

◆ m_fields

amrex::Vector<Field*> amr_wind::BoundaryPlane::m_fields
private

List of fields for IO.

◆ m_filename

std::string amr_wind::BoundaryPlane::m_filename
private

File name for IO.

◆ m_has_overset

bool amr_wind::BoundaryPlane::m_has_overset {false}
private

Flag indicating if the simulation is overset – needed for complicated timing of pre_advance_work.

◆ m_in_data

InletData amr_wind::BoundaryPlane::m_in_data
private

Inlet data.

◆ m_in_rad

const int amr_wind::BoundaryPlane::m_in_rad = 1
private

controls extents on native bndry output

◆ m_in_times

amrex::Vector<amrex::Real> amr_wind::BoundaryPlane::m_in_times
private

NetCDF input level time.

◆ m_in_timesteps

amrex::Vector<int> amr_wind::BoundaryPlane::m_in_timesteps
private

◆ m_io_mode

io_mode amr_wind::BoundaryPlane::m_io_mode {io_mode::undefined}
private

IO mode.

◆ m_mbc

MultiBlockContainer** amr_wind::BoundaryPlane::m_mbc
private

◆ m_mesh

const amrex::AmrCore& amr_wind::BoundaryPlane::m_mesh
private

◆ m_out_counter

size_t amr_wind::BoundaryPlane::m_out_counter {0}
private

NetCDF time output counter.

◆ m_out_fmt

std::string amr_wind::BoundaryPlane::m_out_fmt {"native"}
private

output format for bndry output

◆ m_out_rad

const int amr_wind::BoundaryPlane::m_out_rad = 1
private

◆ m_out_start_time

amrex::Real amr_wind::BoundaryPlane::m_out_start_time {0.0_rt}
private

Start outputting after this time.

◆ m_plane_names

amrex::Vector<std::string> amr_wind::BoundaryPlane::m_plane_names
private
Initial value:
{"xlo", "ylo", "zlo",
"xhi", "yhi", "zhi"}

Plane names.

◆ m_planes

amrex::Vector<std::string> amr_wind::BoundaryPlane::m_planes
private

IO boundary planes.

◆ m_read_erf

ReadERFFunction* amr_wind::BoundaryPlane::m_read_erf {nullptr}
private

◆ m_repo

const FieldRepo& amr_wind::BoundaryPlane::m_repo
private

◆ m_time

const amr_wind::SimTime& amr_wind::BoundaryPlane::m_time
private

◆ m_time_file

std::string amr_wind::BoundaryPlane::m_time_file
private

File name for Native time file.

◆ m_title

std::string amr_wind::BoundaryPlane::m_title {"ABL boundary planes"}
private

◆ m_var_names

amrex::Vector<std::string> amr_wind::BoundaryPlane::m_var_names
private

Variables for IO.

◆ m_write_frequency

int amr_wind::BoundaryPlane::m_write_frequency {1}
private

Normal direction for the boundary plane.

The documentation for this class was generated from the following files:
  • /home/runner/work/amr-wind/amr-wind/amr-wind/boundary_conditions/field_boundary_fill/BoundaryPlane.H
  • /home/runner/work/amr-wind/amr-wind/amr-wind/boundary_conditions/field_boundary_fill/BoundaryPlane.cpp
Generated by doxygen 1.14.0