World Builder  0.1.0-pre
A geodyanmic initial conditions generator
WorldBuilder::World Class Reference

#include <world.h>

Collaboration diagram for WorldBuilder::World:

Public Member Functions

 World (std::string filename)
 
 ~World ()
 
void declare_and_parse (Parameters &parameters)
 
double temperature (const std::array< double, 2 > &point, const double depth, const double gravity_norm) const
 
double temperature (const std::array< double, 3 > &point, const double depth, const double gravity_norm) const
 
bool composition (const std::array< double, 2 > &point, const double depth, const unsigned int composition_number) const
 
bool composition (const std::array< double, 3 > &point, const double depth, const unsigned int composition_number) const
 

Public Attributes

Parameters parameters
 

Static Public Attributes

static const char path_seperator = '.'
 

Detailed Description

Definition at line 38 of file world.h.

Constructor & Destructor Documentation

◆ World()

WorldBuilder::World::World ( std::string  filename)

Constructor. This constructor requires a atring with the location of the world builder file to initialize the world..

Definition at line 39 of file world.cc.

Here is the call graph for this function:

◆ ~World()

WorldBuilder::World::~World ( )

Destructor

Definition at line 47 of file world.cc.

Member Function Documentation

◆ composition() [1/2]

bool WorldBuilder::World::composition ( const std::array< double, 2 > &  point,
const double  depth,
const unsigned int  composition_number 
) const

Definition at line 153 of file world.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ composition() [2/2]

bool WorldBuilder::World::composition ( const std::array< double, 3 > &  point,
const double  depth,
const unsigned int  composition_number 
) const

Definition at line 179 of file world.cc.

Here is the call graph for this function:

◆ declare_and_parse()

void WorldBuilder::World::declare_and_parse ( Parameters parameters)

read in the world builder file

Temperature parameters.

Model rotation parameters.

Coordinate system parameters.

pre-compute stuff for the cross section

Definition at line 50 of file world.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ temperature() [1/2]

double WorldBuilder::World::temperature ( const std::array< double, 2 > &  point,
const double  depth,
const double  gravity_norm 
) const

Definition at line 107 of file world.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ temperature() [2/2]

double WorldBuilder::World::temperature ( const std::array< double, 3 > &  point,
const double  depth,
const double  gravity_norm 
) const

Definition at line 135 of file world.cc.

Here is the call graph for this function:

Member Data Documentation

◆ parameters

Parameters WorldBuilder::World::parameters

Definition at line 72 of file world.h.

◆ path_seperator

const char WorldBuilder::World::path_seperator = '.'
static

Stores the path separtor used for the property tree.

Definition at line 69 of file world.h.


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