LatticeElementBase Struct Reference

#include <LatticeElementBase.H>

Inheritance diagram for LatticeElementBase:

Public Member Functions
	LatticeElementBase (std::string const &element_name)
	LatticeElementBase constructor This gets the input z extent of the element and check for its correctness.
void	AddElementBase (amrex::ParmParse &pp_element, amrex::ParticleReal &z_location)
	Read in an element base data and add it to the lists.
void	WriteToDeviceBase ()
	Write the base element information to the device.

Public Attributes
std::string	m_element_name
int	nelements = 0
std::vector< amrex::ParticleReal >	h_zs
std::vector< amrex::ParticleReal >	h_ze
amrex::Gpu::DeviceVector< amrex::ParticleReal >	d_zs
amrex::Gpu::DeviceVector< amrex::ParticleReal >	d_ze

Constructor & Destructor Documentation

LatticeElementBase()

LatticeElementBase::LatticeElementBase

(

std::string const &

element_name

)

LatticeElementBase constructor This gets the input z extent of the element and check for its correctness.

Parameters

[in]

element_name

the name of the element type

Member Function Documentation

AddElementBase()

void LatticeElementBase::AddElementBase	(	amrex::ParmParse &	pp_element,
		amrex::ParticleReal &	z_location )

Read in an element base data and add it to the lists.

Parameters

[in]	pp_element	The ParmParse instance to read in the data
[in,out]	z_location	The current z location in the lattice

WriteToDeviceBase()

void LatticeElementBase::WriteToDeviceBase

(

)

Write the base element information to the device.

Member Data Documentation

d_ze

amrex::Gpu::DeviceVector<amrex::ParticleReal> LatticeElementBase::d_ze

d_zs

amrex::Gpu::DeviceVector<amrex::ParticleReal> LatticeElementBase::d_zs

h_ze

std::vector<amrex::ParticleReal> LatticeElementBase::h_ze

h_zs

std::vector<amrex::ParticleReal> LatticeElementBase::h_zs

m_element_name

std::string LatticeElementBase::m_element_name

nelements

int LatticeElementBase::nelements = 0

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/AcceleratorLattice/LatticeElements/LatticeElementBase.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/AcceleratorLattice/LatticeElements/LatticeElementBase.cpp