World Builder  0.1.0-pre
A geodyanmic initial conditions generator
Public Member Functions | Protected Attributes | List of all members
WorldBuilder::Features::Interface Class Referenceabstract

#include <interface.h>

Inheritance diagram for WorldBuilder::Features::Interface:
Inheritance graph
[legend]
Collaboration diagram for WorldBuilder::Features::Interface:
Collaboration graph
[legend]

Public Member Functions

 Interface ()
 
virtual ~Interface ()
 
virtual void decare_entries (std::string &path)=0
 
virtual double temperature (const Point< 3 > &position, const double depth, const double gravity, double temperature) const =0
 
virtual bool composition (const Point< 3 > &position, const double depth, const unsigned int composition_number, bool temperature) const =0
 

Protected Attributes

WorldBuilder::World * world
 
std::string name
 
std::vector< Point< 2 > > coordinates
 
std::string temperature_submodule_name
 
std::string composition_submodule_name
 

Detailed Description

Definition at line 46 of file interface.h.

Constructor & Destructor Documentation

◆ Interface()

WorldBuilder::Features::Interface::Interface ( )

constructor

Definition at line 31 of file interface.cc.

◆ ~Interface()

WorldBuilder::Features::Interface::~Interface ( )
virtual

Destructor

Definition at line 34 of file interface.cc.

Member Function Documentation

◆ composition()

virtual bool WorldBuilder::Features::Interface::composition ( const Point< 3 > &  position,
const double  depth,
const unsigned int  composition_number,
bool  temperature 
) const
pure virtual

Returns a value for the reqeusted composition (0 is not present, 1 is present) based on the given position and

Implemented in WorldBuilder::Features::ContinentalPlate.

◆ decare_entries()

virtual void WorldBuilder::Features::Interface::decare_entries ( std::string &  path)
pure virtual

declare and read in the world builder file into the parameters class

Implemented in WorldBuilder::Features::ContinentalPlate.

◆ temperature()

virtual double WorldBuilder::Features::Interface::temperature ( const Point< 3 > &  position,
const double  depth,
const double  gravity,
double  temperature 
) const
pure virtual

takes temperature and position and returns a temperature.

Implemented in WorldBuilder::Features::ContinentalPlate.

Member Data Documentation

◆ composition_submodule_name

std::string WorldBuilder::Features::Interface::composition_submodule_name
protected

The name of the composition submodule used by this feature.

Definition at line 110 of file interface.h.

◆ coordinates

std::vector<Point<2> > WorldBuilder::Features::Interface::coordinates
protected

The coordinates at the surface of the feature

Definition at line 100 of file interface.h.

◆ name

std::string WorldBuilder::Features::Interface::name
protected

The name of the feature type.

Definition at line 95 of file interface.h.

◆ temperature_submodule_name

std::string WorldBuilder::Features::Interface::temperature_submodule_name
protected

The name of the temperature submodule used by this feature.

Definition at line 105 of file interface.h.

◆ world

WorldBuilder::World* WorldBuilder::Features::Interface::world
protected

A pointer to the world class to retrieve variables.

Definition at line 90 of file interface.h.

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