ParticleForce Struct Reference

Force information on a particle. More...

#include <Particle.hpp>

Public Member Functions
	ParticleForce ()=default
	ParticleForce (ParticleForce const &)=default
ParticleForce &	operator= (ParticleForce const &)=default
	ParticleForce (const Utils::Vector3d &f)
	ParticleForce (const Utils::Vector3d &f, const Utils::Vector3d &torque)
ParticleForce &	operator+= (ParticleForce const &rhs)
template<class Archive >
void	serialize (Archive &ar, long int)

Public Attributes
Utils::Vector3d	f = {0., 0., 0.}
	force.
Utils::Vector3d	torque = {0., 0., 0.}
	torque.

Friends
ParticleForce	operator+ (ParticleForce const &lhs, ParticleForce const &rhs)

Detailed Description

Force information on a particle.

Forces of ghost particles are collected and added up to the force of the original particle.

Definition at line 290 of file Particle.hpp.

Constructor & Destructor Documentation

ParticleForce() [1/4]

ParticleForce::ParticleForce ( )

default

ParticleForce() [2/4]

ParticleForce::ParticleForce ( ParticleForce const &  )

default

ParticleForce() [3/4]

ParticleForce::ParticleForce ( const Utils::Vector3d &  f )

inline

Definition at line 294 of file Particle.hpp.

ParticleForce() [4/4]

ParticleForce::ParticleForce ( const Utils::Vector3d &  f, const Utils::Vector3d &  torque  )

inline

Definition at line 296 of file Particle.hpp.

Member Function Documentation

operator+=()

ParticleForce & ParticleForce::operator+= ( ParticleForce const &  rhs )

inline

Definition at line 307 of file Particle.hpp.

References f, and torque.

operator=()

ParticleForce & ParticleForce::operator= ( ParticleForce const &  )

default

serialize()

template<class Archive >

void ParticleForce::serialize ( Archive &  ar, long int    )

inline

Definition at line 323 of file Particle.hpp.

References f, and torque.

Friends And Related Symbol Documentation

operator+

ParticleForce operator+ ( ParticleForce const &  lhs, ParticleForce const &  rhs  )

friend

Definition at line 300 of file Particle.hpp.

Member Data Documentation

f

Utils::Vector3d ParticleForce::f = {0., 0., 0.}

force.

Definition at line 316 of file Particle.hpp.

Referenced by DipolarDirectSum::add_long_range_forces(), add_non_bonded_pair_virials(), calc_opposing_force(), external_force(), Particle::force(), Particle::force(), operator+=(), and serialize().

torque

Utils::Vector3d ParticleForce::torque = {0., 0., 0.}

torque.

Definition at line 320 of file Particle.hpp.

Referenced by calc_opposing_force(), external_force(), Constraints::ShapeBasedConstraint::force(), operator+=(), serialize(), Particle::torque(), and Particle::torque().

---

The documentation for this struct was generated from the following file:

• Particle.hpp