molsim/docs/Cluster_8h_source.html

#pragma once

#include "ParticleContainer.h"

#include <array>


class Cluster {

  protected:

    std::array<double, 3> x;


    double h;


    double m;


    int type;


    double epsilon;


    double sigma;


    std::array<double, 3> v;


    double mean_velocity;


    ParticleContainer &particles;


  public:

    Cluster(ParticleContainer &particles, const std::array<double, 3> &x, const std::array<double, 3> &v, double h,

            double m, int type, double epsilon, double sigma);


    virtual ~Cluster();


    std::array<double, 3> &getX();


    const std::array<double, 3> &getX() const;


    double getH() const;


    double getM() const;


    std::array<double, 3> &getV();


    const std::array<double, 3> &getV() const;


    double getMeanVelocity() const;


    ParticleContainer &getParticles();


    const ParticleContainer &getParticles() const;


    virtual void initialize(size_t dimensions = 2) = 0;

};


ParticleContainer.h
Class for encapsulating and iterating over multiple Particle objects.

Cluster
Abstract class which models common information about Particle objects arranged in some cluster.
Definition Cluster.h:14

Cluster::getH
double getH() const
Gets the distance  between the particles of this Cluster.

Cluster::getX
const std::array< double, 3 > & getX() const
Gets the position  of this Cluster (const).

Cluster::v
std::array< double, 3 > v
Starting velocity  of the particles in the Cluster (before adding Maxwell-Boltzmann perturbations).
Definition Cluster.h:42

Cluster::particles
ParticleContainer & particles
Reference to the ParticleContainer object from the Simulation.
Definition Cluster.h:48

Cluster::getMeanVelocity
double getMeanVelocity() const
Gets the mean velocity for the Maxwell-Boltzmann distribution.

Cluster::type
int type
Type of the particles in the Cluster.
Definition Cluster.h:32

Cluster::getParticles
const ParticleContainer & getParticles() const
Gets the reference to the central ParticleContainer (const).

Cluster::getM
double getM() const
Gets the mass  of the particles of this Cluster.

Cluster::mean_velocity
double mean_velocity
Mean velocity for the Maxwell-Boltzmann distribution.
Definition Cluster.h:45

Cluster::initialize
virtual void initialize(size_t dimensions=2)=0
Initializes the Particle objects in the Cluster.

Cluster::getV
const std::array< double, 3 > & getV() const
Gets the starting velocity  of the particles of this Cluster (const).

Cluster::m
double m
Mass  of the particles in the Cluster.
Definition Cluster.h:29

Cluster::getX
std::array< double, 3 > & getX()
Gets the position  of this Cluster.

Cluster::x
std::array< double, 3 > x
Starting coordinate  of the Cluster.
Definition Cluster.h:23

Cluster::getV
std::array< double, 3 > & getV()
Gets the starting velocity  of the particles of this Cluster.

Cluster::h
double h
Distance  between the particles in the Cluster.
Definition Cluster.h:26

Cluster::~Cluster
virtual ~Cluster()
Destroys the current Cluster.

Cluster::Cluster
Cluster(ParticleContainer &particles, const std::array< double, 3 > &x, const std::array< double, 3 > &v, double h, double m, int type, double epsilon, double sigma)
Constructs a new Cluster.

Cluster::sigma
double sigma
Distance  where the Lennard-Jones potential reaches zero of the particles in the Cluster.
Definition Cluster.h:38

Cluster::getParticles
ParticleContainer & getParticles()
Gets the reference to the central ParticleContainer.

Cluster::epsilon
double epsilon
Depth  of the potential well of the particles in the Cluster.
Definition Cluster.h:35

ParticleContainer
Class for encapsulating multiple Particle objects..
Definition ParticleContainer.h:17

type
Enumeration class corresponding to the type schema type.
Definition vtk-unstructured.h:2125