aboutsummaryrefslogtreecommitdiff
path: root/Source/Particles/Collision
diff options
context:
space:
mode:
authorGravatar Yinjian Zhao <yinjianzhao@lbl.gov> 2019-12-12 08:59:33 -0800
committerGravatar Yinjian Zhao <yinjianzhao@lbl.gov> 2019-12-12 08:59:33 -0800
commit69d1930f99d1a4267692f01bee27565cf518b70c (patch)
tree1267080ad7f92cfb6a47cf0c165df4e2e245cf13 /Source/Particles/Collision
parentc338e431ed1d30c28894318c62a4212556a78dd2 (diff)
downloadWarpX-69d1930f99d1a4267692f01bee27565cf518b70c.tar.gz
WarpX-69d1930f99d1a4267692f01bee27565cf518b70c.tar.zst
WarpX-69d1930f99d1a4267692f01bee27565cf518b70c.zip
Add comments in CollisionType.H.
Diffstat (limited to 'Source/Particles/Collision')
-rw-r--r--Source/Particles/Collision/CollisionType.H10
1 files changed, 10 insertions, 0 deletions
diff --git a/Source/Particles/Collision/CollisionType.H b/Source/Particles/Collision/CollisionType.H
index 22b86f6b2..d020f47e8 100644
--- a/Source/Particles/Collision/CollisionType.H
+++ b/Source/Particles/Collision/CollisionType.H
@@ -18,6 +18,16 @@ public:
const std::vector<std::string>& species_names,
std::string const collision_name);
+ /** Perform all binary collisions within a tile
+ *
+ * @param lev AMR level of the tile
+ * @param mfi iterator for multifab
+ * @param species1/2 pointer to species container
+ * @param isSameSpecies true if collision is between same species
+ * @param CoulombLog user input Coulomb logrithm
+ *
+ */
+
static void doCoulombCollisionsWithinTile (
int const lev, amrex::MFIter const& mfi,
std::unique_ptr<WarpXParticleContainer>& species1,