OscProb
OscProb::PremLayer Struct Reference

A struct representing a spherical shell of matter for earth models. More...

#include <NuPath.h>

Public Member Functions

 PremLayer (double r=0, double d=0, double z=0.5, int ly=0)
 Constructor. More...
 
void SetLayer (double r=0, double d=0, double z=0.5, int ly=0)
 Set the properties of the layer. More...
 
bool operator== (PremLayer &rhs)
 

Public Attributes

double radius
 The outer radius of the layer in km. More...
 
double density
 The density of the layer in g/cm^3. More...
 
double zoa
 The effective Z/A value of the layer. More...
 
int layer
 An index to identify the matter type. More...
 

Detailed Description

This struct stores the properties of a spherical shell to be used by the PremModel class in order to build an earth model. Only the outer radius of the shell is stored, so PremLayer's need to be assembled in order inside a vector.

Author
jcoelho@apc.in2p3.fr

Definition at line 84 of file NuPath.h.

Constructor & Destructor Documentation

◆ PremLayer()

OscProb::PremLayer::PremLayer ( double  r = 0,
double  d = 0,
double  z = 0.5,
int  ly = 0 
)
inline

Constructor.

By default it creates a layer of zero radius and zero density. The effective Z/A value is set to 0.5 by default.

The properties of the layer can be given directly in the construction.

Parameters
r- The outer radius of the layer in km
d- The density of the layer in g/cm^3
z- The effective Z/A value of the layer
ly- An index to identify the matter type (e.g. earth inner core)

Definition at line 101 of file NuPath.h.

102 {
103 SetLayer(r, d, z, ly);
104 }
void SetLayer(double r=0, double d=0, double z=0.5, int ly=0)
Set the properties of the layer.
Definition: NuPath.h:120

References SetLayer().

Member Function Documentation

◆ operator==()

bool OscProb::PremLayer::operator== ( PremLayer rhs)
inline

Define equality as all properties equal except radius

Definition at line 136 of file NuPath.h.

137 {
138 return rhs.density == density && rhs.zoa == zoa && rhs.layer == layer;
139 }
double zoa
The effective Z/A value of the layer.
Definition: NuPath.h:130
double density
The density of the layer in g/cm^3.
Definition: NuPath.h:129
int layer
An index to identify the matter type.
Definition: NuPath.h:131

References density, layer, and zoa.

◆ SetLayer()

void OscProb::PremLayer::SetLayer ( double  r = 0,
double  d = 0,
double  z = 0.5,
int  ly = 0 
)
inline

Set the properties of the layer.

By default it sets the layer to zero radius and zero density. The effective Z/A value is set to 0.5 by default.

Parameters
r- The outer radius of the layer in km
d- The density of the layer in g/cm^3
z- The effective Z/A value of the layer
ly- An index to identify the matter type (e.g. earth inner core)

Definition at line 120 of file NuPath.h.

121 {
122 radius = r;
123 density = d;
124 zoa = z;
125 layer = ly;
126 }
double radius
The outer radius of the layer in km.
Definition: NuPath.h:128

References density, layer, radius, and zoa.

Referenced by PremLayer().

Member Data Documentation

◆ density

double OscProb::PremLayer::density

Definition at line 129 of file NuPath.h.

Referenced by OscProb::PremModel::AddPath(), operator==(), and SetLayer().

◆ layer

int OscProb::PremLayer::layer

Definition at line 131 of file NuPath.h.

Referenced by OscProb::PremModel::AddPath(), operator==(), and SetLayer().

◆ radius

double OscProb::PremLayer::radius

Definition at line 128 of file NuPath.h.

Referenced by OscProb::PremModel::AddDetLayer(), and SetLayer().

◆ zoa

double OscProb::PremLayer::zoa

Definition at line 130 of file NuPath.h.

Referenced by OscProb::PremModel::AddPath(), operator==(), and SetLayer().


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