PartCfg Class Reference

Particle cache on the head node. More...

#include <PartCfg.hpp>

Public Types
using	value_type = Particle

Public Member Functions
	PartCfg (BoxGeometry const &box_geo)
auto	begin ()
	Iterator pointing to the particle with the lowest id.
auto	end ()
	Iterator pointing past the particle with the highest id.
auto	size ()
	Number of particles in the config.
auto	empty ()
	Is the config empty?

Detailed Description

Particle cache on the head node.

This class implements cached access to all particles in a particle range on the head node. This implementation fetches all particles to the head node on creation.

Definition at line 34 of file PartCfg.hpp.

Member Typedef Documentation

value_type

using PartCfg::value_type = Particle

Definition at line 40 of file PartCfg.hpp.

Constructor & Destructor Documentation

PartCfg()

PartCfg::PartCfg ( BoxGeometry const &  box_geo )

inlineexplicit

Definition at line 41 of file PartCfg.hpp.

Member Function Documentation

begin()

auto PartCfg::begin ( )

inline

Iterator pointing to the particle with the lowest id.

Definition at line 46 of file PartCfg.hpp.

empty()

auto PartCfg::empty ( )

inline

Is the config empty?

Definition at line 55 of file PartCfg.hpp.

end()

auto PartCfg::end ( )

inline

Iterator pointing past the particle with the highest id.

Definition at line 49 of file PartCfg.hpp.

size()

auto PartCfg::size ( )

inline

Number of particles in the config.

Definition at line 52 of file PartCfg.hpp.

---

The documentation for this class was generated from the following files:

• PartCfg.hpp
• PartCfg.cpp