diff options
| author |  David Grote <grote1@llnl.gov>
| 2022-12-19 05:43:16 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-12-19 14:43:16 +0100 |
| commit | c3eb6ea1efeff3910e8520d94e260d94367d68f7 (patch) | |
| tree | af59d4a61a92fc602ca224e0fdd45685960de433 /Source/Particles/Collision | |
| parent | 4913d07348eeed38263745a47ffe3a9f9a680076 (diff) | |
| download | WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.tar.gz WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.tar.zst WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.zip | |
Clean up documentation (#3542)
* Fix comments for documentation
* More fixes to comments for documentation
* Fixes in the doc files
* Fix typo in parameters.rst
Diffstat (limited to 'Source/Particles/Collision')
3 files changed, 6 insertions, 1 deletions
diff --git a/Source/Particles/Collision/BinaryCollision/BinaryCollision.H b/Source/Particles/Collision/BinaryCollision/BinaryCollision.H index 0c5ec182e..2c1cdc689 100644 --- a/Source/Particles/Collision/BinaryCollision/BinaryCollision.H +++ b/Source/Particles/Collision/BinaryCollision/BinaryCollision.H @@ -111,8 +111,9 @@ public: * @param mypc Container of species involved * */ - void doCollisions (amrex::Real /*cur_time*/, amrex::Real dt, MultiParticleContainer* mypc) override + void doCollisions (amrex::Real cur_time, amrex::Real dt, MultiParticleContainer* mypc) override { + amrex::ignore_unused(cur_time); auto& species1 = mypc->GetParticleContainerFromName(m_species_names[0]); auto& species2 = mypc->GetParticleContainerFromName(m_species_names[1]); @@ -192,6 +193,7 @@ public: /** Perform all binary collisions within a tile * + * \param[in] dt time step size * \param[in] lev the mesh-refinement level * \param[in] mfi iterator for multifab * \param species_1 first species container diff --git a/Source/Particles/Collision/BinaryCollision/NuclearFusion/BoschHaleFusionCrossSection.H b/Source/Particles/Collision/BinaryCollision/NuclearFusion/BoschHaleFusionCrossSection.H index 08af65ca6..e2a4fca25 100644 --- a/Source/Particles/Collision/BinaryCollision/NuclearFusion/BoschHaleFusionCrossSection.H +++ b/Source/Particles/Collision/BinaryCollision/NuclearFusion/BoschHaleFusionCrossSection.H @@ -21,6 +21,8 @@ * * @param[in] E_kin_star the kinetic energy of the reactants in their center of mass frame, in SI units. * @param[in] fusion_type indicates which fusion reaction to calculate the cross-section for + * @param[in] m1 mass of the incoming particle + * @param[in] m2 mass of the target particle * @return The total cross section in SI units (square meters). */ AMREX_GPU_HOST_DEVICE AMREX_INLINE diff --git a/Source/Particles/Collision/CollisionHandler.cpp b/Source/Particles/Collision/CollisionHandler.cpp index cc8d8eb4a..e8f25a78b 100644 --- a/Source/Particles/Collision/CollisionHandler.cpp +++ b/Source/Particles/Collision/CollisionHandler.cpp @@ -68,6 +68,7 @@ CollisionHandler::CollisionHandler(MultiParticleContainer const * const mypc) /** Perform all collisions * * @param cur_time Current time + * @param dt time step size * @param mypc MultiParticleContainer calling this method * */ |