amr_wind::IntScratchField Class Reference

#include <IntScratchField.H>

Collaboration diagram for amr_wind::IntScratchField:

Public Member Functions
	IntScratchField (const IntScratchField &)=delete
IntScratchField &	operator= (const IntScratchField &)=delete
const std::string &	name () const
	Name if available for this scratch field.
int	num_comp () const
	Number of components for this field.
const amrex::IntVect &	num_grow () const
	Ghost cells.
FieldLoc	field_location () const
	Cell, node, face where the field is stored.
amrex::iMultiFab &	operator() (int lev)
	Return the field data for a given level.
const amrex::iMultiFab &	operator() (int lev) const
amrex::Vector< amrex::iMultiFab * >	vec_ptrs () noexcept
amrex::Vector< const amrex::iMultiFab * >	vec_const_ptrs () const noexcept
const FieldRepo &	repo () const
	Return a reference to the field repository that created this field.
void	setVal (int value) noexcept

Protected Member Functions
	IntScratchField (const FieldRepo &repo, std::string name, const int ncomp=1, const int ngrow=1, const FieldLoc floc=FieldLoc::CELL)

Protected Attributes
const FieldRepo &	m_repo
std::string	m_name
int	m_ncomp
amrex::IntVect	m_ngrow
FieldLoc	m_floc
amrex::Vector< amrex::iMultiFab >	m_data

Friends
class	FieldRepo

Detailed Description

Integer version of ScratchField that works with iMultiFab

Constructor & Destructor Documentation

IntScratchField() [1/2]

amr_wind::IntScratchField::IntScratchField ( const IntScratchField & )

delete

IntScratchField() [2/2]

amr_wind::IntScratchField::IntScratchField ( const FieldRepo & repo, std::string name, const int ncomp = 1, const int ngrow = 1, const FieldLoc floc = FieldLoc::CELL )

inlineprotected

Member Function Documentation

field_location()

FieldLoc amr_wind::IntScratchField::field_location ( ) const

inline

Cell, node, face where the field is stored.

name()

const std::string & amr_wind::IntScratchField::name ( ) const

inline

Name if available for this scratch field.

num_comp()

int amr_wind::IntScratchField::num_comp ( ) const

inline

Number of components for this field.

num_grow()

const amrex::IntVect & amr_wind::IntScratchField::num_grow ( ) const

inline

Ghost cells.

operator()() [1/2]

amrex::iMultiFab & amr_wind::IntScratchField::operator() ( int lev )

inline

Return the field data for a given level.

operator()() [2/2]

const amrex::iMultiFab & amr_wind::IntScratchField::operator() ( int lev ) const

inline

operator=()

IntScratchField & amr_wind::IntScratchField::operator= ( const IntScratchField & )

delete

repo()

const FieldRepo & amr_wind::IntScratchField::repo ( ) const

inline

Return a reference to the field repository that created this field.

setVal()

void amr_wind::IntScratchField::setVal ( int value )

noexcept

vec_const_ptrs()

amrex::Vector< const amrex::iMultiFab * > amr_wind::IntScratchField::vec_const_ptrs ( ) const

inlinenoexcept

vec_ptrs()

amrex::Vector< amrex::iMultiFab * > amr_wind::IntScratchField::vec_ptrs ( )

inlinenoexcept

Friends And Related Symbol Documentation

FieldRepo

friend class FieldRepo

friend

Member Data Documentation

m_data

amrex::Vector<amrex::iMultiFab> amr_wind::IntScratchField::m_data

protected

m_floc

FieldLoc amr_wind::IntScratchField::m_floc

protected

m_name

std::string amr_wind::IntScratchField::m_name

protected

m_ncomp

int amr_wind::IntScratchField::m_ncomp

protected

m_ngrow

amrex::IntVect amr_wind::IntScratchField::m_ngrow

protected

m_repo

const FieldRepo& amr_wind::IntScratchField::m_repo

protected

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/core/IntScratchField.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/core/IntScratchField.cpp