em/process/CoulombScatteringProcess.hh

0001 //----------------------------------*-C++-*----------------------------------//
0002 // Copyright 2023-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/CoulombScatteringProcess.hh
0007 //---------------------------------------------------------------------------//
0008 #pragma once
0009
0010 #include <memory>
0011
0012 #include "celeritas/em/data/CoulombScatteringData.hh"
0013 #include "celeritas/em/model/CoulombScatteringModel.hh"
0014 #include "celeritas/io/ImportParameters.hh"
0015 #include "celeritas/mat/MaterialParams.hh"
0016 #include "celeritas/phys/Applicability.hh"
0017 #include "celeritas/phys/ImportedProcessAdapter.hh"
0018 #include "celeritas/phys/Process.hh"
0019
0020 namespace celeritas
0021 {
0022 //---------------------------------------------------------------------------//
0023 /*!
0024  * Coulomb scattering process for electrons off of atoms.
0025  */
0026 class CoulombScatteringProcess : public Process
0027 {
0028   public:
0029     //!@{
0030     //! \name Type aliases
0031     using SPConstParticles = std::shared_ptr<ParticleParams const>;
0032     using SPConstMaterials = std::shared_ptr<MaterialParams const>;
0033     using SPConstImported = std::shared_ptr<ImportedProcesses const>;
0034     //!@}
0035
0036     struct Options
0037     {
0038         //! Whether to use integral method to sample interaction length
0039         bool use_integral_xs{true};
0040     };
0041
0042   public:
0043     //! Construct from Coulomb scattering data
0044     CoulombScatteringProcess(SPConstParticles particles,
0045                              SPConstMaterials materials,
0046                              SPConstImported process_data,
0047                              Options const& options);
0048
0049     //! Construct the models associated with this process
0050     VecModel build_models(ActionIdIter start_id) const final;
0051
0052     //! Get the interaction cross sections for the given energy range
0053     StepLimitBuilders step_limits(Applicability range) const final;
0054
0055     //! Whether to use the integral method to sample interaction length
0056     bool use_integral_xs() const final;
0057
0058     // Name of the process
0059     std::string_view label() const final;
0060
0061   private:
0062     SPConstParticles particles_;
0063     SPConstMaterials materials_;
0064     ImportedProcessAdapter imported_;
0065     Options options_;
0066 };
0067
0068 //---------------------------------------------------------------------------//
0069 }  // namespace celeritas