BCIface Class Reference

Kynema-SGF API: kynema_sgf::BCIface Class Reference

Kynema-SGF API v0.1.0

CFD solver for wind plant simulations

Loading...

Searching...

No Matches

#include <BCInterface.H>

Inheritance diagram for kynema_sgf::BCIface:

[legend]

Collaboration diagram for kynema_sgf::BCIface:

[legend]

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

Public Member Functions
	BCIface (Field &field)
virtual	~BCIface ()=default
virtual void	operator() (amrex::Real value=0.0_rt)
	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 (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 kynema_sgf::BCIface::IncfloBC = amrex::GpuArray<BC, AMREX_SPACEDIM * 2>

Constructor & Destructor Documentation

◆ BCIface()

kynema_sgf::BCIface::BCIface ( Field & field )

◆ ~BCIface()

virtual kynema_sgf::BCIface::~BCIface ( )

virtualdefault

Member Function Documentation

◆ get_dirichlet_udfs()

amrex::Array< const std::string, 3 > kynema_sgf::BCIface::get_dirichlet_udfs ( )

User-defined functions for Dirichlet-type boundaries.

◆ operator()()

void kynema_sgf::BCIface::operator() ( amrex::Real value = 0.0_rt )

virtual

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

◆ read_bctype()

void kynema_sgf::BCIface::read_bctype ( )

protectedvirtual

Parse custom BCs specified for this field.

◆ read_values()

virtual void kynema_sgf::BCIface::read_values ( )

protectedpure virtual

Read input data for specific fields based on BC types.

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

◆ set_bcfuncs()

void kynema_sgf::BCIface::set_bcfuncs ( )

protectedvirtual

BC functions for Neumann type boundaries.

◆ set_bcrec()

virtual void kynema_sgf::BCIface::set_bcrec ( )

protectedpure virtual

Setup AMReX mathematical BC types.

Implemented in kynema_sgf::BCDensityMod, kynema_sgf::BCFillPatchExtrap, kynema_sgf::BCScalar, kynema_sgf::BCSrcTerm, kynema_sgf::BCVelocity, and kynema_sgf::BCVOF.

◆ set_bcrec_hi()

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

inlineprotected

Set AMReX mathematical boundary types for the upper boundaries.

◆ set_bcrec_lo()

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

inlineprotected

Set AMReX mathematical boundary types for the lower boundaries.

◆ set_default_value()

void kynema_sgf::BCIface::set_default_value ( amrex::Real value )

protected

Set default BC values for the field.

Member Data Documentation

◆ m_field

Field& kynema_sgf::BCIface::m_field