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
weibull Class Reference

Weibull disordered circle/sphere particle. More...

#include <shape.hpp>

Inheritance diagram for weibull:
Inheritance graph
[legend]
Collaboration diagram for weibull:
Collaboration graph
[legend]

Public Member Functions

 weibull ()
 Default constructor. More...
 
 weibull (shape_type &other)
 Copy constructor. More...
 
 weibull (double rin, double bin)
 Constructor defining a spherical particle with a disordered surface. More...
 
 weibull (double betain, double ain, double bin, double cin)
 Constructor defining an ellipsoid particle with a disordered surface. More...
 
 ~weibull ()
 Default destructor. More...
 
bool check (std::vector< int > Is, int l_size)
 Check whether a certain position falls within the particle. More...
 
weibulloperator= (shape_type &other)
 Assignment operator. More...
 
double get_r0 ()
 Returns the characteristic size of a weibull particle. More...
 
double get_beta ()
 Returns the disorder parameter of a weibull particle. More...
 
double get_a ()
 Returns the x-axis radius of a weibull particle. More...
 
double get_b ()
 Returns the y-axis radius of a weibull particle. More...
 
double get_c ()
 Returns the z-axis radius of a weibull particle. More...
 
- Public Member Functions inherited from shape_type
 shape_type ()
 Default constructor. More...
 
 ~shape_type ()
 Default destructor. More...
 

Detailed Description

Weibull disordered circle/sphere particle.

Constructor & Destructor Documentation

weibull::weibull ( )
inline

Default constructor.

weibull::weibull ( shape_type other)

Copy constructor.

weibull::weibull ( double  rin,
double  bin 
)

Constructor defining a spherical particle with a disordered surface.

Parameters
rinThe average radius of the sphere.
binThe disorder parameter.
weibull::weibull ( double  betain,
double  ain,
double  bin,
double  cin 
)

Constructor defining an ellipsoid particle with a disordered surface.

Parameters
betainThe disorder parameter.
ainThe x-axis size of the particle.
binThe y-axis size of the particle.
cinThe z-axis size of the particle.
weibull::~weibull ( )
inline

Default destructor.

Member Function Documentation

bool weibull::check ( std::vector< int >  Is,
int  l_size 
)
virtual

Check whether a certain position falls within the particle.

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

Reimplemented from shape_type.

double weibull::get_a ( )
inlinevirtual

Returns the x-axis radius of a weibull particle.

Reimplemented from shape_type.

double weibull::get_b ( )
inlinevirtual

Returns the y-axis radius of a weibull particle.

Reimplemented from shape_type.

double weibull::get_beta ( )
inlinevirtual

Returns the disorder parameter of a weibull particle.

Reimplemented from shape_type.

double weibull::get_c ( )
inlinevirtual

Returns the z-axis radius of a weibull particle.

Reimplemented from shape_type.

double weibull::get_r0 ( )
inlinevirtual

Returns the characteristic size of a weibull particle.

Reimplemented from shape_type.

weibull& weibull::operator= ( shape_type other)

Assignment operator.


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