Skip to content

Commit

Permalink
Add Doxygen comments for the reserveData and resizeData methods of Pa…
Browse files Browse the repository at this point in the history
…rticleContainerBase.
  • Loading branch information
atmyers committed Apr 3, 2024
1 parent 20bf7ac commit 8430552
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Src/Particle/AMReX_ParticleContainer.H
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,18 @@ public:
return (lev < m_particles.size()) ? m_particles[lev].size() : 0;
}

/**
* \brief This reserves data in the vector of dummy MultiFabs used by
* the ParticleContainer for the maximum number of levels possible.
*/
void reserveData () override;

/**
* \brief This resizes the vector of dummy MultiFabs used by the
* ParticleContainer for the current number of levels and calls
* RedefineDummyMF on each level. Note that this must be done prior
* to using ParticleIterator.
*/
void resizeData () override;

void InitFromAsciiFile (const std::string& file, int extradata,
Expand Down

0 comments on commit 8430552

Please sign in to comment.