molsim/docs/Disc_8h_source.html

#pragma once


#include "Cluster.h"

#include "ParticleContainer.h"

#include <array>

#include <string>

#include <vector>


class Disc : public Cluster {

  private:

    int r;


    std::vector<std::array<double, 3>> getCircleCoordinates(double centerX, double centerY, double radius,

                                                            double distance);


  public:

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

         double m, int type = TYPE_DEFAULT, double epsilon = EPSILON_DEFAULT, double sigma = SIGMA_DEFAULT);


    int getR() const;


    bool operator==(const Disc &other) const;


    bool operator!=(const Disc &other) const;


    void initialize(size_t dimensions = 2) override;


    std::string toString();

};


Cluster.h
Abstract class for defining clusters of Particle objects.

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

TYPE_DEFAULT
#define TYPE_DEFAULT
Definition Particle.h:18

EPSILON_DEFAULT
#define EPSILON_DEFAULT
Definition Particle.h:20

SIGMA_DEFAULT
#define SIGMA_DEFAULT
Definition Particle.h:19

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

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::m
double m
Mass  of the particles in the Cluster.
Definition Cluster.h:29

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

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

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

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

Disc
Class storing metadata about a Particle disc.
Definition Disc.h:21

Disc::getCircleCoordinates
std::vector< std::array< double, 3 > > getCircleCoordinates(double centerX, double centerY, double radius, double distance)
Helper function to get circle point (Particle) coordinates.

Disc::toString
std::string toString()
Returns a string representation of this Disc.

Disc::r
int r
Radius  of the disc in terms of number of particles.
Definition Disc.h:24

Disc::operator!=
bool operator!=(const Disc &other) const
Overload of the inequality operator for Disc objects.

Disc::operator==
bool operator==(const Disc &other) const
Overload of the equality operator for Cuboid objects.

Disc::initialize
void initialize(size_t dimensions=2) override
Main function of Disc class, initializes the particles based on the disc metadata in a grid and adds ...

Disc::Disc
Disc(ParticleContainer &particles, const std::array< double, 3 > &x, int r, const std::array< double, 3 > &v, double h, double m, int type=TYPE_DEFAULT, double epsilon=EPSILON_DEFAULT, double sigma=SIGMA_DEFAULT)
Constructs a new Disc object with all the needed metadata.

Disc::getR
int getR() const
Gets the radius  of this disc.

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