ExternalParticleFields Class Reference

This class contains the parameters for the external particle fields. More...

#include <ExternalParticleFields.H>

Public Member Functions
void	ReadParameters ()
	Read in the parameters via the parser and create the external particle.

Public Attributes
std::vector< ParticleFieldMetaData >	m_E_field_metadata
	Array of E field metadata.
std::vector< ParticleFieldMetaData >	m_B_field_metadata
	Array of B field metadata.
int	m_nEfields
	Number of external E fields.
int	m_nBfields
	Number of external B fields.

Detailed Description

This class contains the parameters for the external particle fields.

Member Function Documentation

ReadParameters()

void ExternalParticleFields::ReadParameters

(

)

Read in the parameters via the parser and create the external particle.

Member Data Documentation

m_B_field_metadata

std::vector<ParticleFieldMetaData> ExternalParticleFields::m_B_field_metadata

Array of B field metadata.

m_E_field_metadata

std::vector<ParticleFieldMetaData> ExternalParticleFields::m_E_field_metadata

Array of E field metadata.

m_nBfields

int ExternalParticleFields::m_nBfields

Number of external B fields.

m_nEfields

int ExternalParticleFields::m_nEfields

Number of external E fields.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6368/Source/Particles/ExternalParticleFields.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6368/Source/Particles/ExternalParticleFields.cpp