amr_wind::BCIface Class Reference

#include <BCInterface.H>

Inheritance diagram for amr_wind::BCIface:

Collaboration diagram for amr_wind::BCIface:

Public Types
using	IncfloBC = amrex::GpuArray<BC, AMREX_SPACEDIM * 2>

Public Member Functions
	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
virtual void	set_bcrec ()=0
	Setup AMReX mathematical BC types.
virtual void	read_values ()=0
	Read input data for specific fields based on BC types.
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.

Protected Attributes
Field &	m_field
	Field instance where BC is being set.

Detailed Description

Abstract class that defines the interface for processing BCs

This class defines the infrastructure to read and initialize the boundary condition information from the input file and populate the necessary data in FieldInfo instance for a given Field.

Member Typedef Documentation

IncfloBC

using amr_wind::BCIface::IncfloBC = amrex::GpuArray<BC, AMREX_SPACEDIM * 2>

Constructor & Destructor Documentation

BCIface()

amr_wind::BCIface::BCIface

(

Field &

field

)

~BCIface()

virtual amr_wind::BCIface::~BCIface ( )

virtualdefault

Member Function Documentation

get_dirichlet_udfs()

amrex::Array< const std::string, 3 > amr_wind::BCIface::get_dirichlet_udfs

(

)

User-defined functions for Dirichlet-type boundaries.

operator()()

void amr_wind::BCIface::operator() ( const amrex::Real value = 0.0 )

virtual

Operator that performs init actions and syncs the BC data to device.

read_bctype()

void amr_wind::BCIface::read_bctype ( )

protectedvirtual

Parse custom BCs specified for this field.

read_values()

virtual void amr_wind::BCIface::read_values ( )

protectedpure virtual

Read input data for specific fields based on BC types.

Implemented in amr_wind::BCFillPatchExtrap, amr_wind::BCPressure, amr_wind::BCScalar, amr_wind::BCSrcTerm, amr_wind::BCVelocity, and amr_wind::BCVOF.

set_bcfuncs()

void amr_wind::BCIface::set_bcfuncs ( )

protectedvirtual

BC functions for Neumann type boundaries.

set_bcrec()

virtual void amr_wind::BCIface::set_bcrec ( )

protectedpure virtual

Setup AMReX mathematical BC types.

Implemented in amr_wind::BCFillPatchExtrap, amr_wind::BCScalar, amr_wind::BCSrcTerm, amr_wind::BCVelocity, and amr_wind::BCVOF.

set_bcrec_hi()

void amr_wind::BCIface::set_bcrec_hi ( int dir, amrex::BCType::mathematicalBndryTypes bcrec )

inlineprotected

Set AMReX mathematical boundary types for the upper boundaries.

set_bcrec_lo()

void amr_wind::BCIface::set_bcrec_lo ( int dir, amrex::BCType::mathematicalBndryTypes bcrec )

inlineprotected

Set AMReX mathematical boundary types for the lower boundaries.

set_default_value()

void amr_wind::BCIface::set_default_value ( const amrex::Real value )

inlineprotected

Set default BC values for the field.

Member Data Documentation

m_field

Field& amr_wind::BCIface::m_field

protected

Field instance where BC is being set.

---

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