kynema_sgf::subvolume::SubvolumeBase Class Reference

#include <SubvolumeBase.H>

Inheritance diagram for kynema_sgf::subvolume::SubvolumeBase:

Collaboration diagram for kynema_sgf::subvolume::SubvolumeBase:

Public Member Functions
	~SubvolumeBase () override=default
virtual std::string	label () const =0
	Name used to refer to this sampler (e.g., myline1)
virtual std::string &	label ()=0
virtual std::string	subvolumetype () const =0
	Class name of this sampler (e.g., Rectangular)
virtual void	initialize (const std::string &key)=0
	Read inputs.
virtual void	evaluate_inputs ()=0
	Check inputs and prepare for output.
virtual void	post_init_actions ()
	Run actions after initialize.
virtual void	post_regrid_actions ()
	Run actions after regrid.
virtual int	lev () const
	Level that the subvolume corresponds to.
virtual amrex::BoxArray	box_array () const
	BoxArray that the subvolume corresponds to.
Public Member Functions inherited from kynema_sgf::Factory< SubvolumeBase, CFDSim & >
virtual	~Factory ()=default

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

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

Detailed Description

Abstract representation of subvolume constraints to sample flow data

This class defines the interface by which the positions of the subvolumes are defined and access from the Subvolume class. All subvolume definitions must be sub-classes of this base class.

Constructor & Destructor Documentation

~SubvolumeBase()

kynema_sgf::subvolume::SubvolumeBase::~SubvolumeBase ( )

overridedefault

Member Function Documentation

base_identifier()

std::string kynema_sgf::subvolume::SubvolumeBase::base_identifier ( )

inlinestatic

box_array()

virtual amrex::BoxArray kynema_sgf::subvolume::SubvolumeBase::box_array ( ) const

inlinenodiscardvirtual

BoxArray that the subvolume corresponds to.

evaluate_inputs()

virtual void kynema_sgf::subvolume::SubvolumeBase::evaluate_inputs ( )

pure virtual

Check inputs and prepare for output.

initialize()

virtual void kynema_sgf::subvolume::SubvolumeBase::initialize ( const std::string & key )

pure virtual

Read inputs.

label() [1/2]

virtual std::string kynema_sgf::subvolume::SubvolumeBase::label ( ) const

nodiscardpure virtual

Name used to refer to this sampler (e.g., myline1)

label() [2/2]

virtual std::string & kynema_sgf::subvolume::SubvolumeBase::label ( )

pure virtual

lev()

virtual int kynema_sgf::subvolume::SubvolumeBase::lev ( ) const

inlinenodiscardvirtual

Level that the subvolume corresponds to.

post_init_actions()

virtual void kynema_sgf::subvolume::SubvolumeBase::post_init_actions ( )

inlinevirtual

Run actions after initialize.

post_regrid_actions()

virtual void kynema_sgf::subvolume::SubvolumeBase::post_regrid_actions ( )

inlinevirtual

Run actions after regrid.

subvolumetype()

virtual std::string kynema_sgf::subvolume::SubvolumeBase::subvolumetype ( ) const

nodiscardpure virtual

Class name of this sampler (e.g., Rectangular)

---

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

• /home/runner/work/kynema-sgf/kynema-sgf/src/utilities/subvolume/SubvolumeBase.H