ImpactX.H

Go to the documentation of this file.

/* Copyright 2022-2023 The Regents of the University of California, through Lawrence
 *           Berkeley National Laboratory (subject to receipt of any required
 *           approvals from the U.S. Dept. of Energy). All rights reserved.
 *
 * This file is part of ImpactX.
 *
 * Authors: Axel Huebl, Chad Mitchell, Ji Qiang
 * License: BSD-3-Clause-LBNL
 */
#ifndef IMPACT_X_H
#define IMPACT_X_H
 
#include "elements/All.H"
#include "initialization/AmrCoreData.H"
#include "particles/distribution/All.H"
#include "tracking/TrackingState.H"
 
#include <AMReX_REAL.H>
 
#include <functional>
#include <list>
#include <memory>
#include <string>
#include <unordered_map>
 
 
namespace impactx
{
    class ImpactX
    {
      public:
        ImpactX ();
 
        // removed constructors/assignments
        ImpactX (ImpactX const&) = delete;
        ImpactX (ImpactX &&) = delete;
        void operator= (ImpactX const&) = delete;
        void operator= (ImpactX &&) = delete;

        ~ImpactX ();

        void finalize ();

        void finalize_elements ();

        void init_grids ();

        void initBeamDistributionFromInputs ();

        void initLatticeElementsFromInputs ();

        void
        add_particles (
            amrex::ParticleReal bunch_charge,
            distribution::KnownDistributions distr,
            amrex::Long npart,
            std::optional<distribution::SpinvMF> spin_distr = std::nullopt
        );

        void validate ();

        bool early_param_check ();

        void evolve ();

        void track_particles ();

        void track_envelope ();

        void track_reference (RefPart & ref);

        void init_warning_logger ();

        std::unique_ptr<initialization::AmrCoreData> amr_data;

        void ResizeMesh ();

        std::list<elements::KnownElements> m_lattice;

        bool initialized ()
        {
            return m_grids_initialized;
        }

        void call_hook (std::string const & name);
 
        std::unordered_map<
            std::string,
            std::function<void(ImpactX *)>
        > m_hook;  

        TrackingState m_tracking_state;
 
      private:
        bool m_grids_initialized = false;
    };
 
} // namespace impactx
 
#endif // IMPACT_X_H