BCScalar Class Reference

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

#include <BCInterface.H>

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

Public Member Functions

 BCScalar (Field &field)
 
- Public Member Functions inherited from amr_wind::BCIface
 BCIface (Field &field)
 
virtual ~BCIface ()=default
 
virtual void operator() (const amrex::Real value=0.0)
 Operator that performs init actions and syncs the BC data to device.
 
amrex::Array< const std::string, 3 > get_dirichlet_udfs ()
 User-defined functions for Dirichlet-type boundaries.
 

Protected Member Functions

void set_bcrec () override
 Setup AMReX mathematical BC types.
 
void read_values () override
 Read input data for specific fields based on BC types.
 
- Protected Member Functions inherited from amr_wind::BCIface
virtual void read_bctype ()
 Parse custom BCs specified for this field.
 
virtual void set_bcfuncs ()
 BC functions for Neumann type boundaries.
 
void set_default_value (const amrex::Real value)
 Set default BC values for the field.
 
void set_bcrec_lo (int dir, amrex::BCType::mathematicalBndryTypes bcrec)
 Set AMReX mathematical boundary types for the lower boundaries.
 
void set_bcrec_hi (int dir, amrex::BCType::mathematicalBndryTypes bcrec)
 Set AMReX mathematical boundary types for the upper boundaries.
 

Additional Inherited Members

- Public Types inherited from amr_wind::BCIface
using IncfloBC = amrex::GpuArray<BC, AMREX_SPACEDIM * 2>
 
- Protected Attributes inherited from amr_wind::BCIface
Fieldm_field
 Field instance where BC is being set.
 

Detailed Description

Boundary condition initialization for scalar transport variables

Constructor & Destructor Documentation

◆ BCScalar()

amr_wind::BCScalar::BCScalar ( Field & field)
inlineexplicit

Member Function Documentation

◆ read_values()

void amr_wind::BCScalar::read_values ( )
overrideprotectedvirtual

Read input data for specific fields based on BC types.

Implements amr_wind::BCIface.

◆ set_bcrec()

void amr_wind::BCScalar::set_bcrec ( )
overrideprotectedvirtual

Setup AMReX mathematical BC types.

Implements amr_wind::BCIface.


The documentation for this class was generated from the following files:
  • /home/runner/work/amr-wind/amr-wind/amr-wind/boundary_conditions/BCInterface.H
  • /home/runner/work/amr-wind/amr-wind/amr-wind/boundary_conditions/BCInterface.cpp