Struct to store data related to external electromagnetic fields (flags, field values, and field parsers) More...

#include <ExternalField.H>

Public Member Functions
	ExternalFieldParams (const amrex::ParmParse &pp_warpx)
	The constructor reads and stores the parameters related to the external fields. "pp_warpx" must point at the "warpx" parameter group in the inputfile. More...

Public Attributes
amrex::GpuArray< amrex::Real, 3 >	E_external_grid = {0,0,0}
	Initial electric field on the grid. More...

amrex::GpuArray< amrex::Real, 3 >	B_external_grid = {0,0,0}
	Initial magnetic field on the grid. More...

ExternalFieldType	B_ext_grid_type = ExternalFieldType::default_zero
	Initialization type for external magnetic field on the grid. More...

ExternalFieldType	E_ext_grid_type = ExternalFieldType::default_zero
	Initialization type for external electric field on the grid. More...

std::unique_ptr< amrex::Parser >	Bxfield_parser
	User-defined parser to initialize x-component of the magnetic field on the grid. More...

std::unique_ptr< amrex::Parser >	Byfield_parser
	User-defined parser to initialize y-component of the magnetic field on the grid. More...

std::unique_ptr< amrex::Parser >	Bzfield_parser
	User-defined parser to initialize z-component of the magnetic field on the grid. More...

std::unique_ptr< amrex::Parser >	Exfield_parser
	User-defined parser to initialize x-component of the electric field on the grid. More...

std::unique_ptr< amrex::Parser >	Eyfield_parser
	User-defined parser to initialize y-component of the electric field on the grid. More...

std::unique_ptr< amrex::Parser >	Ezfield_parser
	User-defined parser to initialize z-component of the electric field on the grid. More...

std::string	external_fields_path
	Path of the file where external fields are stored. More...

Detailed Description

Struct to store data related to external electromagnetic fields (flags, field values, and field parsers)

Constructor & Destructor Documentation

◆ ExternalFieldParams()

ExternalFieldParams::ExternalFieldParams ( const amrex::ParmParse & pp_warpx )

The constructor reads and stores the parameters related to the external fields. "pp_warpx" must point at the "warpx" parameter group in the inputfile.

Strings storing parser function to initialize the components of the magnetic field on the grid

Strings storing parser function to initialize the components of the electric field on the grid

Member Data Documentation

◆ B_ext_grid_type

ExternalFieldType ExternalFieldParams::B_ext_grid_type = ExternalFieldType::default_zero

Initialization type for external magnetic field on the grid.

◆ B_external_grid

amrex::GpuArray<amrex::Real,3> ExternalFieldParams::B_external_grid = {0,0,0}

Initial magnetic field on the grid.

◆ Bxfield_parser

std::unique_ptr<amrex::Parser> ExternalFieldParams::Bxfield_parser

User-defined parser to initialize x-component of the magnetic field on the grid.

◆ Byfield_parser

std::unique_ptr<amrex::Parser> ExternalFieldParams::Byfield_parser

User-defined parser to initialize y-component of the magnetic field on the grid.

◆ Bzfield_parser

std::unique_ptr<amrex::Parser> ExternalFieldParams::Bzfield_parser

User-defined parser to initialize z-component of the magnetic field on the grid.

◆ E_ext_grid_type

ExternalFieldType ExternalFieldParams::E_ext_grid_type = ExternalFieldType::default_zero

Initialization type for external electric field on the grid.

◆ E_external_grid

amrex::GpuArray<amrex::Real,3> ExternalFieldParams::E_external_grid = {0,0,0}

Initial electric field on the grid.

◆ Exfield_parser

std::unique_ptr<amrex::Parser> ExternalFieldParams::Exfield_parser

User-defined parser to initialize x-component of the electric field on the grid.

◆ external_fields_path

std::string ExternalFieldParams::external_fields_path

Path of the file where external fields are stored.

◆ Eyfield_parser

std::unique_ptr<amrex::Parser> ExternalFieldParams::Eyfield_parser

User-defined parser to initialize y-component of the electric field on the grid.

◆ Ezfield_parser

std::unique_ptr<amrex::Parser> ExternalFieldParams::Ezfield_parser

User-defined parser to initialize z-component of the electric field on the grid.

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

/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/latest/Source/Initialization/ExternalField.H
/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/latest/Source/Initialization/ExternalField.cpp

Public Member Functions

Public Attributes