amr_wind::FieldBoundary Class Reference

#include <FieldBoundary.H>

Inheritance diagram for amr_wind::FieldBoundary:

Collaboration diagram for amr_wind::FieldBoundary:

Public Member Functions
	~FieldBoundary () override=default
virtual void	post_init_actions ()=0
	Actions to perform post initialization.
virtual void	pre_advance_work ()=0
	Perform tasks necessary before advancing timestep.
virtual void	pre_predictor_work ()
	Perform tasks necessary only once per timestep, after pre_advance.
virtual void	post_advance_work ()=0
	Perform tasks necessary after advancing timestep.
virtual void	set_velocity (int, amrex::Real, const Field &, amrex::MultiFab &, int=0, int=0) const =0
	Velocity fill function to be used by nodal projection.
Public Member Functions inherited from amr_wind::Factory< FieldBoundary, CFDSim & >
virtual	~Factory ()=default

Static Public Member Functions
static std::string	base_identifier ()
Static Public Member Functions inherited from amr_wind::Factory< FieldBoundary, CFDSim & >
static std::unique_ptr< FieldBoundary >	create (const std::string &key, Args... args)
static void	print (std::ostream &os)

Additional Inherited Members
Public Attributes inherited from amr_wind::Factory< FieldBoundary, CFDSim & >
friend	Base

Detailed Description

Abstract representation of field-boundary fill models

This class mirrors the runtime-registration model used by Physics and provides hook points for boundary-fill specific setup and time-stepping actions.

Constructor & Destructor Documentation

~FieldBoundary()

amr_wind::FieldBoundary::~FieldBoundary ( )

overridedefault

Member Function Documentation

base_identifier()

std::string amr_wind::FieldBoundary::base_identifier ( )

inlinestatic

post_advance_work()

virtual void amr_wind::FieldBoundary::post_advance_work ( )

pure virtual

Perform tasks necessary after advancing timestep.

post_init_actions()

virtual void amr_wind::FieldBoundary::post_init_actions ( )

pure virtual

Actions to perform post initialization.

pre_advance_work()

virtual void amr_wind::FieldBoundary::pre_advance_work ( )

pure virtual

Perform tasks necessary before advancing timestep.

pre_predictor_work()

virtual void amr_wind::FieldBoundary::pre_predictor_work ( )

inlinevirtual

Perform tasks necessary only once per timestep, after pre_advance.

set_velocity()

virtual void amr_wind::FieldBoundary::set_velocity ( int , amrex::Real , const Field & , amrex::MultiFab & , int = 0, int = 0 ) const

pure virtual

Velocity fill function to be used by nodal projection.

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/boundary_conditions/field_boundary_fill/FieldBoundary.H