Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup some docstrings #4714

Merged
merged 1 commit into from
Feb 22, 2024
Merged

Cleanup some docstrings #4714

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions Source/Particles/MultiParticleContainer.H
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,11 @@ public:

void InitMultiPhysicsModules ();

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

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

///
/// This pushes the particle momenta by dt for all the species in the
/// MultiParticleContainer. It is used to desynchronize the particles after initialization
/// or when restarting from a checkpoint. It is also used to synchronize particles at the
/// the end of the run. This is the electromagnetic version.
///
/**
* This pushes the particle momenta by dt for all the species in the
* MultiParticleContainer. It is used to desynchronize the particles after initialization
* or when restarting from a checkpoint. It is also used to synchronize particles at the
* the end of the run. This is the electromagnetic version.
*/
void PushP (int lev, amrex::Real dt,
const amrex::MultiFab& Ex, const amrex::MultiFab& Ey, const amrex::MultiFab& Ez,
const amrex::MultiFab& Bx, const amrex::MultiFab& By, const amrex::MultiFab& Bz);
Expand Down
Loading