amr_wind::FieldInfo Struct Reference

#include <Field.H>

Collaboration diagram for amr_wind::FieldInfo:

Public Member Functions
	FieldInfo (std::string basename, const int ncomp, const int ngrow, const int nstates, const FieldLoc floc)
	~FieldInfo ()
bool	bc_initialized ()
	Check indicating whether BCs are being set to sane values.
void	copy_bc_to_device () noexcept
	Copy the BC information to device data structures.

Public Attributes
std::string	m_basename
	Field name without state information.
int	m_ncomp
	Number of components (Scalar = 1, Vector = 2, etc.)
amrex::IntVect	m_ngrow
	Ghost cells.
int	m_nstates
	Number of states available for this field.
FieldLoc	m_floc
	Cell, node, face centered field type.
amrex::Vector< Field * >	m_states
	Vector holding references to available states for this field.
std::unique_ptr< FieldFillPatchOpsBase >	m_fillpatch_op
	Function that handles filling patch and physics BC data for this field.
amrex::Vector< std::unique_ptr< FieldBCIface > >	m_bc_func
	Custom boundary condition actions for this field.
bool	m_bc_copied_to_device {false}
	Flag indicating whether BCs have been initialized and copied to device.
amrex::GpuArray< BC, AMREX_SPACEDIM *2 >	m_bc_type
amrex::Vector< amrex::Vector< amrex::Real > >	m_bc_values
amrex::GpuArray< const amrex::Real *, AMREX_SPACEDIM *2 >	m_bc_values_d
amrex::Gpu::DeviceVector< amrex::Real >	m_bc_values_dview
amrex::Vector< amrex::BCRec >	m_bcrec
amrex::Gpu::DeviceVector< amrex::BCRec >	m_bcrec_d

Static Public Attributes
static constexpr int	max_field_states = 5
	Maximum number of states allowed for a field.

Detailed Description

Information common to a field that has multiple states

Constructor & Destructor Documentation

FieldInfo()

amr_wind::FieldInfo::FieldInfo	(	std::string	basename,
		const int	ncomp,
		const int	ngrow,
		const int	nstates,
		const FieldLoc	floc )

~FieldInfo()

amr_wind::FieldInfo::~FieldInfo ( )

default

Member Function Documentation

bc_initialized()

bool amr_wind::FieldInfo::bc_initialized

(

)

Check indicating whether BCs are being set to sane values.

copy_bc_to_device()

void amr_wind::FieldInfo::copy_bc_to_device ( )

noexcept

Copy the BC information to device data structures.

Member Data Documentation

m_basename

std::string amr_wind::FieldInfo::m_basename

Field name without state information.

m_bc_copied_to_device

bool amr_wind::FieldInfo::m_bc_copied_to_device {false}

Flag indicating whether BCs have been initialized and copied to device.

m_bc_func

amrex::Vector<std::unique_ptr<FieldBCIface> > amr_wind::FieldInfo::m_bc_func

Custom boundary condition actions for this field.

m_bc_type

amrex::GpuArray<BC, AMREX_SPACEDIM * 2> amr_wind::FieldInfo::m_bc_type

Boundary condition data

m_bc_values

amrex::Vector<amrex::Vector<amrex::Real> > amr_wind::FieldInfo::m_bc_values

m_bc_values_d

amrex::GpuArray<const amrex::Real*, AMREX_SPACEDIM * 2> amr_wind::FieldInfo::m_bc_values_d

m_bc_values_dview

amrex::Gpu::DeviceVector<amrex::Real> amr_wind::FieldInfo::m_bc_values_dview

m_bcrec

amrex::Vector<amrex::BCRec> amr_wind::FieldInfo::m_bcrec

m_bcrec_d

amrex::Gpu::DeviceVector<amrex::BCRec> amr_wind::FieldInfo::m_bcrec_d

m_fillpatch_op

std::unique_ptr<FieldFillPatchOpsBase> amr_wind::FieldInfo::m_fillpatch_op

Function that handles filling patch and physics BC data for this field.

m_floc

FieldLoc amr_wind::FieldInfo::m_floc

Cell, node, face centered field type.

m_ncomp

int amr_wind::FieldInfo::m_ncomp

Number of components (Scalar = 1, Vector = 2, etc.)

m_ngrow

amrex::IntVect amr_wind::FieldInfo::m_ngrow

Ghost cells.

m_nstates

int amr_wind::FieldInfo::m_nstates

Number of states available for this field.

m_states

amrex::Vector<Field*> amr_wind::FieldInfo::m_states

Vector holding references to available states for this field.

max_field_states

int amr_wind::FieldInfo::max_field_states = 5

staticconstexpr

Maximum number of states allowed for a field.

---

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

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