Molecular Dynamics Simulation  1.0
Public Member Functions | List of all members
IntegrationFunctor Class Referenceabstract

Interface for numerical integration methods. More...

#include <IntegrationFunctor.h>

Inheritance diagram for IntegrationFunctor:
Inheritance graph
Collaboration diagram for IntegrationFunctor:
Collaboration graph

Public Member Functions

virtual ~IntegrationFunctor ()=default
 Virtual default destructor for the interface. More...
 
virtual void step (std::unique_ptr< ParticleContainer > &particle_container, const std::vector< std::shared_ptr< SimpleForceSource >> &simple_force_sources, const std::vector< std::shared_ptr< PairwiseForceSource >> &pairwise_force_sources, const std::vector< std::shared_ptr< TargettedForceSource >> &targetted_force_sources, double delta_t, double curr_simulation_time) const =0
 Performs one step with the respective integration method. More...
 

Detailed Description

Interface for numerical integration methods.

This is used to ensure inheriting classes implement the method step, which performs one step with the respective integration method, thus updating the positions, velocities and forces of the particles.

Definition at line 14 of file IntegrationFunctor.h.

Constructor & Destructor Documentation

◆ ~IntegrationFunctor()

virtual IntegrationFunctor::~IntegrationFunctor ( )
virtualdefault

Virtual default destructor for the interface.

Member Function Documentation

◆ step()

virtual void IntegrationFunctor::step ( std::unique_ptr< ParticleContainer > &  particle_container,
const std::vector< std::shared_ptr< SimpleForceSource >> &  simple_force_sources,
const std::vector< std::shared_ptr< PairwiseForceSource >> &  pairwise_force_sources,
const std::vector< std::shared_ptr< TargettedForceSource >> &  targetted_force_sources,
double  delta_t,
double  curr_simulation_time 
) const
pure virtual

Performs one step with the respective integration method.

Parameters
particle_containerContainer of particles on which the integration step is applied
simple_force_sourcesVector of simple force sources which are used to calculate the new forces
pairwise_force_sourcesVector of pairwise force sources which are used to calculate the new forces
targetted_force_sourcesVector of targetted force sources which are used to calculate the new forces
delta_tTime step
curr_simulation_timeCurrent simulation time

Implemented in VerletFunctor.


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