#include <ImpactX.H>

Inheritance diagram for impactx::ImpactX:

Public Member Functions
	ImpactX ()

	ImpactX (ImpactX const &)=delete

	ImpactX (ImpactX &&)=delete

void	operator= (ImpactX const &)=delete

void	operator= (ImpactX &&)=delete

void	initGrids ()

void	initBeamDistributionFromInputs ()

void	initLatticeElementsFromInputs ()

void	add_particles (amrex::ParticleReal bunch_charge, distribution::KnownDistributions distr, int npart)

void	validate ()

bool	early_param_check ()

void	evolve ()

void	init_warning_logger ()

void	ResizeMesh ()

Public Member Functions inherited from amrex::AmrCore
	AmrCore ()

	AmrCore (const RealBox rb, int max_level_in, const Vector< int > &n_cell_in, int coord=-1, Vector< IntVect > ref_ratios=Vector< IntVect >(), const int is_per=nullptr)

	AmrCore (const RealBox &rb, int max_level_in, const Vector< int > &n_cell_in, int coord, Vector< IntVect > const &ref_ratios, Array< int, AMREX_SPACEDIM > const &is_per)

	AmrCore (Geometry const &level_0_geom, AmrInfo const &amr_info)

	AmrCore (AmrCore &&rhs) noexcept

AmrCore &	operator= (AmrCore &&rhs) noexcept

	AmrCore (const AmrCore &rhs)=delete

AmrCore &	operator= (const AmrCore &rhs)=delete

	~AmrCore () override

void	InitFromScratch (Real time)

virtual void	regrid (int lbase, Real time, bool initial=false)

void	printGridSummary (std::ostream &os, int min_lev, int max_lev) const noexcept

Public Member Functions inherited from amrex::AmrMesh
	AmrMesh ()

	AmrMesh (const RealBox rb, int max_level_in, const Vector< int > &n_cell_in, int coord=-1, Vector< IntVect > refrat=Vector< IntVect >(), const int is_per=nullptr)

	AmrMesh (const RealBox &rb, int max_level_in, const Vector< int > &n_cell_in, int coord, Vector< IntVect > const &a_refrat, Array< int, AMREX_SPACEDIM > const &is_per)

	AmrMesh (Geometry const &level_0_geom, AmrInfo const &amr_info)

	AmrMesh (const AmrMesh &rhs)=delete

AmrMesh &	operator= (const AmrMesh &rhs)=delete

	AmrMesh (AmrMesh &&rhs)=default

AmrMesh &	operator= (AmrMesh &&rhs)=default

virtual	~AmrMesh ()=default

int	Verbose () const noexcept

int	maxLevel () const noexcept

int	finestLevel () const noexcept

IntVect	refRatio (int lev) const noexcept

int	MaxRefRatio (int lev) const noexcept

const Vector< IntVect > &	refRatio () const noexcept

const Vector< Geometry > &	Geom () const noexcept

const Vector< DistributionMapping > &	DistributionMap () const noexcept

const Vector< BoxArray > &	boxArray () const noexcept

const Geometry &	Geom (int lev) const noexcept

const DistributionMapping &	DistributionMap (int lev) const noexcept

const BoxArray &	boxArray (int lev) const noexcept

Vector< Geometry >	Geom (int a_coarsest_lev, int a_finest_lev) const noexcept

Vector< BoxArray >	boxArray (int a_coarsest_lev, int a_finest_lev) const noexcept

Vector< DistributionMapping >	DistributionMap (int a_coarsest_lev, int a_finest_lev) const noexcept

Vector< Geometry > &	Geom () noexcept

Geometry &	Geom (int lev) noexcept

void	SetMaxGridSize (int new_mgs) noexcept

void	SetMaxGridSize (const IntVect &new_mgs) noexcept

void	SetMaxGridSize (const Vector< int > &new_mgs) noexcept

void	SetMaxGridSize (const Vector< IntVect > &new_mgs) noexcept

void	SetBlockingFactor (int new_bf) noexcept

void	SetBlockingFactor (const IntVect &new_bf) noexcept

void	SetBlockingFactor (const Vector< int > &new_bf) noexcept

void	SetBlockingFactor (const Vector< IntVect > &new_bf) noexcept

void	SetGridEff (Real eff) noexcept

void	SetNProper (int n) noexcept

void	SetFinestLevel (int new_finest_level) noexcept

void	SetDistributionMap (int lev, const DistributionMapping &dmap_in) noexcept

void	SetBoxArray (int lev, const BoxArray &ba_in) noexcept

void	SetGeometry (int lev, const Geometry &geom_in) noexcept

int	GetLevel (Box const &domain) noexcept

void	ClearDistributionMap (int lev) noexcept

void	ClearBoxArray (int lev) noexcept

int	nErrorBuf (int lev, int direction=0) const noexcept

const IntVect &	nErrorBufVect (int lev) const noexcept

Real	gridEff () const noexcept

int	nProper () const noexcept

const IntVect &	blockingFactor (int lev) const noexcept

const IntVect &	maxGridSize (int lev) const noexcept

bool	LevelDefined (int lev) noexcept

bool	useFixedCoarseGrids () const noexcept

int	useFixedUpToLevel () const noexcept

void	ChopGrids (int lev, BoxArray &ba, int target_size) const

BoxArray	MakeBaseGrids () const

void	MakeNewGrids (int lbase, Real time, int &new_finest, Vector< BoxArray > &new_grids)

void	MakeNewGrids (Real time=0.0)

virtual void	ManualTagsPlacement (int, TagBoxArray &, const Vector< IntVect > &)

virtual void	PostProcessBaseGrids (BoxArray &) const

virtual BoxArray	GetAreaNotToTag (int)

long	CountCells (int lev) noexcept

Public Attributes
std::unique_ptr< ImpactXParticleContainer >	m_particle_container

std::unordered_map< int, amrex::MultiFab >	m_rho

std::unordered_map< int, amrex::MultiFab >	m_phi

std::unordered_map< int, std::unordered_map< std::string, amrex::MultiFab > >	m_space_charge_field

std::list< KnownElements >	m_lattice

Private Member Functions
void	ErrorEst (int lev, amrex::TagBoxArray &tags, amrex::Real time, int ngrow) override
	Tag cells for refinement. TagBoxArray tags is built on level lev grids. More...

void	MakeNewLevelFromScratch (int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override

void	MakeNewLevelFromCoarse (int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
	Make a new level using provided BoxArray and DistributionMapping and fill. More...

void	RemakeLevel (int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
	Remake an existing level using provided BoxArray and DistributionMapping. More...

void	ClearLevel (int lev) override
	Delete level data. More...

Additional Inherited Members
Protected Member Functions inherited from amrex::AmrCore
void	ErrorEst (int lev, TagBoxArray &tags, Real time, int ngrow) override=0

void	MakeNewLevelFromScratch (int lev, Real time, const BoxArray &ba, const DistributionMapping &dm) override=0

virtual void	MakeNewLevelFromCoarse (int lev, Real time, const BoxArray &ba, const DistributionMapping &dm)=0

virtual void	RemakeLevel (int lev, Real time, const BoxArray &ba, const DistributionMapping &dm)=0

Protected Member Functions inherited from amrex::AmrMesh
void	checkInput ()

void	SetIterateToFalse () noexcept

void	SetUseNewChop () noexcept

Protected Attributes inherited from amrex::AmrMesh
int	finest_level

Vector< Geometry >	geom

Vector< DistributionMapping >	dmap

Vector< BoxArray >	grids

unsigned int	num_setdm

unsigned int	num_setba

Protected Attributes inherited from amrex::AmrInfo
int	verbose

int	max_level

Vector< IntVect >	ref_ratio

Vector< IntVect >	blocking_factor

Vector< IntVect >	max_grid_size

Vector< IntVect >	n_error_buf

Real	grid_eff

int	n_proper

int	use_fixed_upto_level

bool	use_fixed_coarse_grids

bool	refine_grid_layout

IntVect	refine_grid_layout_dims

bool	check_input

bool	use_new_chop

bool	iterate_on_new_grids

Detailed Description

An ImpactX simulation

This is the central ImpactX simulation class

Constructor & Destructor Documentation

◆ ImpactX() [1/3]

impactx::ImpactX::ImpactX ( )

Construct an ImpactX simulation object

◆ ImpactX() [2/3]

impactx::ImpactX::ImpactX ( ImpactX const & )

delete

◆ ImpactX() [3/3]

impactx::ImpactX::ImpactX ( ImpactX && )

delete

Member Function Documentation

◆ add_particles()

void impactx::ImpactX::add_particles	(	amrex::ParticleReal	bunch_charge,
		distribution::KnownDistributions	distr,
		int	npart
	)

Generate and add n particles to the particle container

Will also resize the geometry based on the updated particle distribution's extent and then redistribute particles in according AMReX grid boxes.

Parameters

bunch_charge	bunch charge (C)
distr	distribution function to draw from (object)
npart	number of particles to draw

◆ ClearLevel()

void impactx::ImpactX::ClearLevel ( int lev )

overrideprivatevirtual

Delete level data.

Delete level data

Implements amrex::AmrCore.

◆ early_param_check()

bool impactx::ImpactX::early_param_check ( )

Check inputs for unused parameters (e.g. typos) after step 1

Returns: true if successful

◆ ErrorEst()

void impactx::ImpactX::ErrorEst	(	int	lev,
		amrex::TagBoxArray &	tags,
		amrex::Real	time,
		int	ngrow
	)

overrideprivate

Tag cells for refinement. TagBoxArray tags is built on level lev grids.

Todo:: this function is not (yet) implemented.

◆ evolve()

void impactx::ImpactX::evolve ( )

Run the main simulation loop for a number of steps

◆ init_warning_logger()

void impactx::ImpactX::init_warning_logger ( )

Query input for warning logger variables and set up warning logger accordingly

Input variables are: always_warn_immediately and abort_on_warning_threshold.

◆ initBeamDistributionFromInputs()

void impactx::ImpactX::initBeamDistributionFromInputs ( )

Initialize the particle beam distribution

This clears and initialized the particle beam from input file and command-line options, as parsed by amrex::ParmParse.

◆ initGrids()

void impactx::ImpactX::initGrids ( )

Initialize AMReX blocks/grids for domain decomposition & space charge mesh.

This must come first, before particle beams and lattice elements are initialized.

◆ initLatticeElementsFromInputs()

void impactx::ImpactX::initLatticeElementsFromInputs ( )

Initialize the list of lattice elements

This clears and initialized the accelerator lattice elements from input file and command-line options, as parsed by amrex::ParmParse.

◆ MakeNewLevelFromCoarse()

void impactx::ImpactX::MakeNewLevelFromCoarse	(	int	lev,
		amrex::Real	time,
		const amrex::BoxArray &	ba,
		const amrex::DistributionMapping &	dm
	)

overrideprivate

Make a new level using provided BoxArray and DistributionMapping and fill.

Make a new level using provided BoxArray and DistributionMapping and fill with interpolated coarse level data.

Todo:: this function is not (yet) implemented.

◆ MakeNewLevelFromScratch()

void impactx::ImpactX::MakeNewLevelFromScratch	(	int	lev,
		amrex::Real	time,
		const amrex::BoxArray &	ba,
		const amrex::DistributionMapping &	dm
	)

overrideprivate

Make a new level from scratch using provided BoxArray and DistributionMapping. Only used during initialization.

◆ operator=() [1/2]

void impactx::ImpactX::operator= ( ImpactX && )

delete

◆ operator=() [2/2]

void impactx::ImpactX::operator= ( ImpactX const & )

delete

◆ RemakeLevel()

void impactx::ImpactX::RemakeLevel	(	int	lev,
		amrex::Real	time,
		const amrex::BoxArray &	ba,
		const amrex::DistributionMapping &	dm
	)

overrideprivate

Remake an existing level using provided BoxArray and DistributionMapping.

Remake an existing level using provided BoxArray and DistributionMapping and fill with existing fine and coarse data.

Todo:: this function is not (yet) implemented.

◆ ResizeMesh()

void impactx::ImpactX::ResizeMesh ( )

Resize the mesh, based on the extent of the bunch of particle

This only changes the physical extent of the mesh, but not the number of grid cells.

◆ validate()

void impactx::ImpactX::validate ( )

Validate the simulation is ready to run via

See also: evolve

Member Data Documentation

◆ m_lattice

std::list<KnownElements> impactx::ImpactX::m_lattice

these are elements defining the accelerator lattice

◆ m_particle_container

std::unique_ptr<ImpactXParticleContainer> impactx::ImpactX::m_particle_container

these are the physical/beam particles of the simulation

◆ m_phi

std::unordered_map<int, amrex::MultiFab> impactx::ImpactX::m_phi

scalar potential per level

◆ m_rho

std::unordered_map<int, amrex::MultiFab> impactx::ImpactX::m_rho

charge density per level

◆ m_space_charge_field

std::unordered_map<int, std::unordered_map<std::string, amrex::MultiFab> > impactx::ImpactX::m_space_charge_field

space charge field (vector) per level

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

/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/23.06/src/ImpactX.H
/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/23.06/src/ImpactX.cpp
/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/23.06/src/initialization/InitDistribution.cpp
/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/23.06/src/initialization/InitElement.cpp
/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/23.06/src/initialization/InitMeshRefinement.cpp
/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/23.06/src/initialization/Validate.cpp
/home/docs/checkouts/readthedocs.org/user_builds/impactx/checkouts/23.06/src/initialization/Warnings.cpp

Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImpactX() [1/3]

◆ ImpactX() [2/3]

◆ ImpactX() [3/3]

Member Function Documentation

◆ add_particles()

◆ ClearLevel()

◆ early_param_check()

◆ ErrorEst()

◆ evolve()

◆ init_warning_logger()

◆ initBeamDistributionFromInputs()

◆ initGrids()

◆ initLatticeElementsFromInputs()

◆ MakeNewLevelFromCoarse()

◆ MakeNewLevelFromScratch()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ RemakeLevel()

◆ ResizeMesh()

◆ validate()

Member Data Documentation

◆ m_lattice

◆ m_particle_container

◆ m_phi

◆ m_rho

◆ m_space_charge_field