SPH
Public Member Functions | Public Attributes | List of all members
PowerLawSfd Struct Reference

Holds the information about a power-law size-frequency distributions. More...

#include <Initial.h>

Public Member Functions

INLINE Float operator() (const Float x) const
 Generates a new value of the SFD by transforming given value from interval [0, 1]. More...
 

Public Attributes

Float exponent
 
Interval interval
 Minimal and maximal value of the SFD. More...
 

Detailed Description

Holds the information about a power-law size-frequency distributions.

Definition at line 73 of file Initial.h.

Member Function Documentation

◆ operator()()

INLINE Float PowerLawSfd::operator() ( const Float  x) const
inline

Generates a new value of the SFD by transforming given value from interval [0, 1].

For x=0 and x=1, interval.lower() and interval.upper() is returned, respectively. Input value must lie in unit interval, checked by assert.

Definition at line 87 of file Initial.h.

Member Data Documentation

◆ exponent

Float PowerLawSfd::exponent

Exponent alpha of the power-law x^-alpha.

Can be lower than 1 or negative, meaning there is more larger modies than smaller bodies. Cannot be exactly 1.

Definition at line 78 of file Initial.h.

◆ interval

Interval PowerLawSfd::interval

Minimal and maximal value of the SFD.

Definition at line 81 of file Initial.h.


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