kynema_sgf::subvolume::RectangularSubvolume Class Reference

#include <RectangularSubvolume.H>

Inheritance diagram for kynema_sgf::subvolume::RectangularSubvolume:

Collaboration diagram for kynema_sgf::subvolume::RectangularSubvolume:

Public Member Functions
	RectangularSubvolume (const CFDSim &)
	~RectangularSubvolume () override
void	initialize (const std::string &key) override
void	evaluate_inputs () override
	Check if inputs have a valid correspondence in the mesh and save quantities for output steps.
std::string	label () const override
	Name of this subvolume object.
std::string &	label () override
std::string	subvolumetype () const override
	Type of this subvolume object.
int	lev () const override
amrex::BoxArray	box_array () const override

Static Public Member Functions
static std::string	identifier ()

Protected Attributes
const CFDSim &	m_sim
amrex::Vector< amrex::Real >	m_origin
amrex::Vector< int >	m_npts_vec
amrex::Vector< amrex::Real >	m_dx_vec
amrex::Vector< int >	m_chunk_size_vec
int	m_lev_for_sub {0}
int	m_verbose {0}
bool	m_chunk_size_present
amrex::BoxArray	m_ba
std::string	m_label

Detailed Description

Get subvolume defined by 3D rectangle

Defines volume region with origin, number of points in each direction, and target mesh resolution in each direction. Also has an optional parameter regarding the data organization, which is the chunk size.

Constructor & Destructor Documentation

RectangularSubvolume()

kynema_sgf::subvolume::RectangularSubvolume::RectangularSubvolume ( const CFDSim & sim )

explicit

~RectangularSubvolume()

kynema_sgf::subvolume::RectangularSubvolume::~RectangularSubvolume ( )

overridedefault

Member Function Documentation

box_array()

amrex::BoxArray kynema_sgf::subvolume::RectangularSubvolume::box_array ( ) const

inlineoverride

evaluate_inputs()

void kynema_sgf::subvolume::RectangularSubvolume::evaluate_inputs ( )

override

Check if inputs have a valid correspondence in the mesh and save quantities for output steps.

identifier()

std::string kynema_sgf::subvolume::RectangularSubvolume::identifier ( )

inlinestatic

initialize()

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

override

Read user inputs and initialize the subvolume object

Parameters

key	Prefix used to parse inputs from file

label() [1/2]

std::string kynema_sgf::subvolume::RectangularSubvolume::label ( ) const

inlineoverride

Name of this subvolume object.

label() [2/2]

std::string & kynema_sgf::subvolume::RectangularSubvolume::label ( )

inlineoverride

lev()

int kynema_sgf::subvolume::RectangularSubvolume::lev ( ) const

inlineoverride

subvolumetype()

std::string kynema_sgf::subvolume::RectangularSubvolume::subvolumetype ( ) const

inlineoverride

Type of this subvolume object.

Member Data Documentation

m_ba

amrex::BoxArray kynema_sgf::subvolume::RectangularSubvolume::m_ba

protected

m_chunk_size_present

bool kynema_sgf::subvolume::RectangularSubvolume::m_chunk_size_present

protected

m_chunk_size_vec

amrex::Vector<int> kynema_sgf::subvolume::RectangularSubvolume::m_chunk_size_vec

protected

m_dx_vec

amrex::Vector<amrex::Real> kynema_sgf::subvolume::RectangularSubvolume::m_dx_vec

protected

m_label

std::string kynema_sgf::subvolume::RectangularSubvolume::m_label

protected

m_lev_for_sub

int kynema_sgf::subvolume::RectangularSubvolume::m_lev_for_sub {0}

protected

m_npts_vec

amrex::Vector<int> kynema_sgf::subvolume::RectangularSubvolume::m_npts_vec

protected

m_origin

amrex::Vector<amrex::Real> kynema_sgf::subvolume::RectangularSubvolume::m_origin

protected

m_sim

const CFDSim& kynema_sgf::subvolume::RectangularSubvolume::m_sim

protected

m_verbose

int kynema_sgf::subvolume::RectangularSubvolume::m_verbose {0}

protected

---

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

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