MC_HAMR  v0.01
Monte Carlo Simulation Software for Atomistic Models of Magnetic Materials for Heat Assisted Magnetic Recording
Public Member Functions | List of all members
particle::shape_type Class Reference

Base class for particle shapes. More...

#include <shape.hpp>

Inheritance diagram for particle::shape_type:
Inheritance graph
[legend]

Public Member Functions

 shape_type ()
 Default constructor. More...
 
 ~shape_type ()
 Default destructor. More...
 
virtual bool check (std::vector< int > Is, int l_size)
 Check whether a certain position falls within the particle. More...
 
virtual double get_r0 ()
 Returns the characteristic size of a weibull particle. More...
 
virtual double get_beta ()
 Returns the disorder parameter of a weibull particle. More...
 
virtual double get_a ()
 Returns the x-axis radius of a weibull particle. More...
 
virtual double get_b ()
 Returns the y-axis radius of a weibull particle. More...
 
virtual double get_c ()
 Returns the z-axis radius of a weibull particle. More...
 

Detailed Description

Base class for particle shapes.

Constructor & Destructor Documentation

particle::shape_type::shape_type ( )
inline

Default constructor.

particle::shape_type::~shape_type ( )
inline

Default destructor.

Member Function Documentation

virtual bool particle::shape_type::check ( std::vector< int >  Is,
int  l_size 
)
inlinevirtual

Check whether a certain position falls within the particle.

Parameters
IsThe coordinates of the lattice site.
l_sizeThe total lattice size.

Reimplemented in particle::weibull, particle::shape_3d, and particle::shape_2d.

virtual double particle::shape_type::get_a ( )
inlinevirtual

Returns the x-axis radius of a weibull particle.

Reimplemented in particle::weibull.

virtual double particle::shape_type::get_b ( )
inlinevirtual

Returns the y-axis radius of a weibull particle.

Reimplemented in particle::weibull.

virtual double particle::shape_type::get_beta ( )
inlinevirtual

Returns the disorder parameter of a weibull particle.

Reimplemented in particle::weibull.

virtual double particle::shape_type::get_c ( )
inlinevirtual

Returns the z-axis radius of a weibull particle.

Reimplemented in particle::weibull.

virtual double particle::shape_type::get_r0 ( )
inlinevirtual

Returns the characteristic size of a weibull particle.

Reimplemented in particle::weibull.


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