amr_wind::IntField Class Reference

#include <IntField.H>

Collaboration diagram for amr_wind::IntField:

Public Member Functions
	IntField (const IntField &)=delete
IntField &	operator= (const IntField &)=delete
const std::string &	name () const
	Name of the field.
unsigned	id () const
	Unique integer ID for this field.
int	num_comp () const
	Number of components for this field.
const amrex::IntVect &	num_grow () const
	Number of ghost cells.
FieldLoc	field_location () const
	Location of the field.
const FieldRepo &	repo () const
	Reference to the FieldRepo that holds the fabs.
amrex::iMultiFab &	operator() (int lev) noexcept
	Access the FAB at a given level.
const amrex::iMultiFab &	operator() (int lev) const noexcept
amrex::Vector< amrex::iMultiFab * >	vec_ptrs () noexcept
amrex::Vector< const amrex::iMultiFab * >	vec_const_ptrs () const noexcept
void	setVal (int value) noexcept
void	setVal (int value, int start_comp, int num_comp=1, int nghost=0) noexcept
void	setVal (const amrex::Vector< int > &values, int nghost=0) noexcept

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

Protected Attributes
FieldRepo &	m_repo
std::string	m_name
const unsigned	m_id
int	m_ncomp
amrex::IntVect	m_ngrow
FieldLoc	m_floc

Friends
class	FieldRepo

Detailed Description

An integer computational field

Used to indicate masking and overset state with IBlanking

Constructor & Destructor Documentation

IntField() [1/2]

amr_wind::IntField::IntField ( const IntField & )

delete

IntField() [2/2]

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

protected

Member Function Documentation

field_location()

FieldLoc amr_wind::IntField::field_location ( ) const

inline

Location of the field.

id()

unsigned amr_wind::IntField::id ( ) const

inline

Unique integer ID for this field.

name()

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

inline

Name of the field.

num_comp()

int amr_wind::IntField::num_comp ( ) const

inline

Number of components for this field.

num_grow()

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

inline

Number of ghost cells.

operator()() [1/2]

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

noexcept

operator()() [2/2]

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

noexcept

Access the FAB at a given level.

operator=()

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

delete

repo()

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

inline

Reference to the FieldRepo that holds the fabs.

setVal() [1/3]

void amr_wind::IntField::setVal ( const amrex::Vector< int > & values, int nghost = 0 )

noexcept

setVal() [2/3]

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

noexcept

setVal() [3/3]

void amr_wind::IntField::setVal ( int value, int start_comp, int num_comp = 1, int nghost = 0 )

noexcept

vec_const_ptrs()

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

noexcept

vec_ptrs()

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

noexcept

Friends And Related Symbol Documentation

FieldRepo

friend class FieldRepo

friend

Member Data Documentation

m_floc

FieldLoc amr_wind::IntField::m_floc

protected

m_id

const unsigned amr_wind::IntField::m_id

protected

m_name

std::string amr_wind::IntField::m_name

protected

m_ncomp

int amr_wind::IntField::m_ncomp

protected

m_ngrow

amrex::IntVect amr_wind::IntField::m_ngrow

protected

m_repo

FieldRepo& amr_wind::IntField::m_repo

protected

---

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

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