neutron/process/NeutronCaptureProcess.hh

0001 //------------------------------- -*- C++ -*- -------------------------------//
0002 // Copyright Celeritas contributors: see top-level COPYRIGHT file for details
0003 // SPDX-License-Identifier: (Apache-2.0 OR MIT)
0004 //---------------------------------------------------------------------------//
0005 //! \file celeritas/neutron/process/NeutronCaptureProcess.hh
0006 //---------------------------------------------------------------------------//
0007 #pragma once
0008
0009 #include <functional>
0010 #include <memory>
0011
0012 #include "corecel/inp/Grid.hh"
0013 #include "celeritas/mat/MaterialParams.hh"
0014 #include "celeritas/phys/Applicability.hh"
0015 #include "celeritas/phys/AtomicNumber.hh"
0016 #include "celeritas/phys/ParticleParams.hh"
0017 #include "celeritas/phys/Process.hh"
0018
0019 namespace celeritas
0020 {
0021 //---------------------------------------------------------------------------//
0022 /*!
0023  * Capture process for neutrons.
0024  */
0025 class NeutronCaptureProcess : public Process
0026 {
0027   public:
0028     //!@{
0029     //! \name Type aliases
0030     using SPConstParticles = std::shared_ptr<ParticleParams const>;
0031     using SPConstMaterials = std::shared_ptr<MaterialParams const>;
0032     using ReadData = std::function<inp::Grid(AtomicNumber)>;
0033     //!@}
0034
0035   public:
0036     // Construct from particle, material, and external cross section data
0037     NeutronCaptureProcess(SPConstParticles particles,
0038                           SPConstMaterials materials,
0039                           ReadData load_data);
0040
0041     // Construct the models associated with this process
0042     VecModel build_models(ActionIdIter start_id) const final;
0043
0044     // Get the interaction cross sections for the given energy range
0045     XsGrid macro_xs(Applicability range) const final;
0046
0047     // Get the energy loss for the given energy range
0048     EnergyLossGrid energy_loss(Applicability range) const final;
0049
0050     //! Whether the integral method can be used to sample interaction length
0051     bool supports_integral_xs() const final { return false; }
0052
0053     //! Whether the process applies when the particle is stopped
0054     bool applies_at_rest() const final { return false; }
0055
0056     // Name of the process
0057     std::string_view label() const final;
0058
0059   private:
0060     SPConstParticles particles_;
0061     SPConstMaterials materials_;
0062     ReadData load_data_;
0063     ParticleId neutron_id_;
0064 };
0065
0066 //---------------------------------------------------------------------------//
0067 }  // namespace celeritas