amr_wind::subvolume::Subvolume Class Reference

#include <Subvolume.H>

Inheritance diagram for amr_wind::subvolume::Subvolume:

Collaboration diagram for amr_wind::subvolume::Subvolume:

Public Member Functions
	Subvolume (CFDSim &, std::string)
	~Subvolume () override
void	pre_init_actions () override
	Perform actions before mesh is created.
void	initialize () override
	Read user inputs for chunks, output timing.
void	post_regrid_actions () override
	Do any work that needs to happen after regrid.
void	output_actions () override
	Get chunks and output to disk.
void	post_advance_work () override
	Actions to do at end of every time step.
const amrex::Vector< std::string > &	var_names () const

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

Private Attributes
CFDSim &	m_sim
amrex::Vector< std::unique_ptr< SubvolumeBase > >	m_subvolumes
amrex::Vector< std::string >	m_var_names
	List of variable names for output.
amrex::Vector< Field * >	m_fields
	List of fields to be sampled for this collection of probes.
amrex::Vector< IntField * >	m_int_fields
	List of IntFields to be sampled for this collection of probes.
std::unique_ptr< DerivedQtyMgr >	m_derived_mgr
	List of derived fields to be sampled for this collection of probes.
const std::string	m_label
std::string	m_label_out
int	m_ncomp {0}
int	m_nicomp {0}
int	m_ndcomp {0}

Constructor & Destructor Documentation

Subvolume()

amr_wind::subvolume::Subvolume::Subvolume	(	CFDSim &	sim,
		std::string	label )

~Subvolume()

amr_wind::subvolume::Subvolume::~Subvolume ( )

overridedefault

Member Function Documentation

identifier()

std::string amr_wind::subvolume::Subvolume::identifier ( )

inlinestatic

initialize()

void amr_wind::subvolume::Subvolume::initialize ( )

override

Read user inputs for chunks, output timing.

output_actions()

void amr_wind::subvolume::Subvolume::output_actions ( )

override

Get chunks and output to disk.

post_advance_work()

void amr_wind::subvolume::Subvolume::post_advance_work ( )

inlineoverride

Actions to do at end of every time step.

post_regrid_actions()

void amr_wind::subvolume::Subvolume::post_regrid_actions ( )

override

Do any work that needs to happen after regrid.

pre_init_actions()

void amr_wind::subvolume::Subvolume::pre_init_actions ( )

inlineoverride

Perform actions before mesh is created.

var_names()

const amrex::Vector< std::string > & amr_wind::subvolume::Subvolume::var_names ( ) const

inlinenodiscard

Member Data Documentation

m_derived_mgr

std::unique_ptr<DerivedQtyMgr> amr_wind::subvolume::Subvolume::m_derived_mgr

private

List of derived fields to be sampled for this collection of probes.

m_fields

amrex::Vector<Field*> amr_wind::subvolume::Subvolume::m_fields

private

List of fields to be sampled for this collection of probes.

m_int_fields

amrex::Vector<IntField*> amr_wind::subvolume::Subvolume::m_int_fields

private

List of IntFields to be sampled for this collection of probes.

m_label

const std::string amr_wind::subvolume::Subvolume::m_label

private

Name of this subvolume object.

The label is used to read user inputs from file and is also used for naming files directories.

m_label_out

std::string amr_wind::subvolume::Subvolume::m_label_out

private

Name of this subvolume object when writing outputs.

This label can be specified to manually override the true label of this subvolume instance. Intended for unified top-level naming of different subvolume instances, but it is up to the user to ensure that the bottom-level names are distinct when this is used.

m_ncomp

int amr_wind::subvolume::Subvolume::m_ncomp {0}

private

m_ndcomp

int amr_wind::subvolume::Subvolume::m_ndcomp {0}

private

m_nicomp

int amr_wind::subvolume::Subvolume::m_nicomp {0}

private

m_sim

CFDSim& amr_wind::subvolume::Subvolume::m_sim

private

m_subvolumes

amrex::Vector<std::unique_ptr<SubvolumeBase> > amr_wind::subvolume::Subvolume::m_subvolumes

private

m_var_names

amrex::Vector<std::string> amr_wind::subvolume::Subvolume::m_var_names

private

List of variable names for output.

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/subvolume/Subvolume.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/subvolume/Subvolume.cpp