em/process/EIonizationProcess.hh

0001 //----------------------------------*-C++-*----------------------------------//
0002 // Copyright 2021-2024 UT-Battelle, LLC, and other Celeritas developers.
0003 // See the top-level COPYRIGHT file for details.
0004 // SPDX-License-Identifier: (Apache-2.0 OR MIT)
0005 //---------------------------------------------------------------------------//
0006 //! \file celeritas/em/process/EIonizationProcess.hh
0007 //---------------------------------------------------------------------------//
0008 #pragma once
0009
0010 #include <memory>
0011
0012 #include "celeritas/phys/Applicability.hh"
0013 #include "celeritas/phys/ImportedProcessAdapter.hh"
0014 #include "celeritas/phys/ParticleParams.hh"
0015 #include "celeritas/phys/Process.hh"
0016
0017 namespace celeritas
0018 {
0019 //---------------------------------------------------------------------------//
0020 /*!
0021  * Ionization process for electrons and positrons.
0022  */
0023 class EIonizationProcess : public Process
0024 {
0025   public:
0026     //!@{
0027     //! \name Type aliases
0028     using SPConstParticles = std::shared_ptr<ParticleParams const>;
0029     using SPConstImported = std::shared_ptr<ImportedProcesses const>;
0030     //!@}
0031
0032     // Options for electron and positron ionization
0033     struct Options
0034     {
0035         bool use_integral_xs{true};  //!> Use integral method for sampling
0036                                      //! discrete interaction length
0037     };
0038
0039   public:
0040     // Construct with imported data
0041     EIonizationProcess(SPConstParticles particles,
0042                        SPConstImported process_data,
0043                        Options options);
0044
0045     // Construct the models associated with this process
0046     VecModel build_models(ActionIdIter start_id) const final;
0047
0048     // Get the interaction cross sections for the given energy range
0049     StepLimitBuilders step_limits(Applicability applicability) const final;
0050
0051     //! Whether to use the integral method to sample interaction length
0052     bool use_integral_xs() const final { return options_.use_integral_xs; }
0053
0054     // Name of the process
0055     std::string_view label() const final;
0056
0057   private:
0058     SPConstParticles particles_;
0059     ImportedProcessAdapter imported_;
0060     Options options_;
0061 };
0062
0063 //---------------------------------------------------------------------------//
0064 }  // namespace celeritas