Skip to content

Commit f40084e

Browse files
authored
Cleanup some docstrings (#4714)
1 parent 994fedd commit f40084e

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

Source/Particles/MultiParticleContainer.H

+15-16
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,11 @@ public:
9595

9696
void InitMultiPhysicsModules ();
9797

98-
///
99-
/// This evolves all the particles by one PIC time step, including current deposition, the
100-
/// field solve, and pushing the particles, for all the species in the MultiParticleContainer.
101-
/// This is the electromagnetic version.
102-
///
98+
/**
99+
* \brief This evolves all the particles by one PIC time step, including current deposition, the
100+
* field solve, and pushing the particles, for all the species in the MultiParticleContainer.
101+
* This is the electromagnetic version.
102+
*/
103103
void Evolve (int lev,
104104
const amrex::MultiFab& Ex, const amrex::MultiFab& Ey, const amrex::MultiFab& Ez,
105105
const amrex::MultiFab& Bx, const amrex::MultiFab& By, const amrex::MultiFab& Bz,
@@ -111,19 +111,18 @@ public:
111111
amrex::Real t, amrex::Real dt, DtType a_dt_type=DtType::Full, bool skip_deposition=false,
112112
PushType push_type=PushType::Explicit);
113113

114-
///
115-
/// This pushes the particle positions by one half time step for all the species in the
116-
/// MultiParticleContainer. It is used to desynchronize the particles after initialization
117-
/// or when restarting from a checkpoint.
118-
///
114+
/**
115+
* \brief This pushes the particle positions by one time step for all the species in the
116+
* MultiParticleContainer.
117+
*/
119118
void PushX (amrex::Real dt);
120119

121-
///
122-
/// This pushes the particle momenta by dt for all the species in the
123-
/// MultiParticleContainer. It is used to desynchronize the particles after initialization
124-
/// or when restarting from a checkpoint. It is also used to synchronize particles at the
125-
/// the end of the run. This is the electromagnetic version.
126-
///
120+
/**
121+
* This pushes the particle momenta by dt for all the species in the
122+
* MultiParticleContainer. It is used to desynchronize the particles after initialization
123+
* or when restarting from a checkpoint. It is also used to synchronize particles at the
124+
* the end of the run. This is the electromagnetic version.
125+
*/
127126
void PushP (int lev, amrex::Real dt,
128127
const amrex::MultiFab& Ex, const amrex::MultiFab& Ey, const amrex::MultiFab& Ez,
129128
const amrex::MultiFab& Bx, const amrex::MultiFab& By, const amrex::MultiFab& Bz);

0 commit comments

Comments
 (0)