World Builder  1.1.0-pre
A geodynamic initial conditions generator
WorldBuilder Namespace Reference

Namespaces

 Consts
 
 CoordinateSystems
 
 Features
 
 FT
 
 GravityModel
 
 KDTree
 
 NaN
 
 Objects
 
 Types
 
 Utilities
 

Classes

class  BoundingBox
 
struct  grains
 
class  Parameters
 
class  Point
 
class  World
 

Enumerations

enum  CoordinateSystem { cartesian, spherical, invalid }
 
enum  DepthMethod {
  angle_at_starting_point_with_surface, angle_at_begin_segment_with_surface, angle_at_begin_segment_applied_to_end_segment_with_surface, continuous_angle_with_surface,
  none
}
 

Functions

template std::unique_ptr< CoordinateSystems::InterfaceParameters::get_unique_pointer< CoordinateSystems::Interface > (const std::string &name)
 
template std::unique_ptr< GravityModel::InterfaceParameters::get_unique_pointer< GravityModel::Interface > (const std::string &name)
 
template bool Parameters::get_unique_pointers< Features::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::ContinentalPlateModels::Temperature::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::ContinentalPlateModels::Temperature::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::ContinentalPlateModels::Composition::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::ContinentalPlateModels::Composition::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::ContinentalPlateModels::Grains::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::ContinentalPlateModels::Grains::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::ContinentalPlateModels::Velocity::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::ContinentalPlateModels::Velocity::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::PlumeModels::Temperature::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::PlumeModels::Temperature::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::PlumeModels::Composition::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::PlumeModels::Composition::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::PlumeModels::Grains::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::PlumeModels::Grains::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::PlumeModels::Velocity::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::PlumeModels::Velocity::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::OceanicPlateModels::Temperature::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::OceanicPlateModels::Temperature::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::OceanicPlateModels::Composition::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::OceanicPlateModels::Composition::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::OceanicPlateModels::Grains::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::OceanicPlateModels::Grains::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::OceanicPlateModels::Velocity::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::OceanicPlateModels::Velocity::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::MantleLayerModels::Temperature::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::MantleLayerModels::Temperature::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::MantleLayerModels::Composition::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::MantleLayerModels::Composition::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::MantleLayerModels::Grains::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::MantleLayerModels::Grains::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::MantleLayerModels::Velocity::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::MantleLayerModels::Velocity::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::SubductingPlateModels::Temperature::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::SubductingPlateModels::Temperature::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::SubductingPlateModels::Composition::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::SubductingPlateModels::Composition::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::SubductingPlateModels::Grains::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::SubductingPlateModels::Grains::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::SubductingPlateModels::Velocity::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::SubductingPlateModels::Velocity::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::FaultModels::Temperature::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::FaultModels::Temperature::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::FaultModels::Composition::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::FaultModels::Composition::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::FaultModels::Grains::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::FaultModels::Grains::Interface > > &vector)
 
template bool Parameters::get_unique_pointers< Features::FaultModels::Velocity::Interface > (const std::string &name, std::vector< std::unique_ptr< Features::FaultModels::Velocity::Interface > > &vector)
 
template bool Parameters::get_shared_pointers< Features::SubductingPlateModels::Temperature::Interface > (const std::string &name, std::vector< std::shared_ptr< Features::SubductingPlateModels::Temperature::Interface > > &vector)
 
template bool Parameters::get_shared_pointers< Features::SubductingPlateModels::Composition::Interface > (const std::string &name, std::vector< std::shared_ptr< Features::SubductingPlateModels::Composition::Interface > > &vector)
 
template bool Parameters::get_shared_pointers< Features::SubductingPlateModels::Grains::Interface > (const std::string &name, std::vector< std::shared_ptr< Features::SubductingPlateModels::Grains::Interface > > &vector)
 
template bool Parameters::get_shared_pointers< Features::SubductingPlateModels::Velocity::Interface > (const std::string &name, std::vector< std::shared_ptr< Features::SubductingPlateModels::Velocity::Interface > > &vector)
 
template bool Parameters::get_shared_pointers< Features::FaultModels::Temperature::Interface > (const std::string &name, std::vector< std::shared_ptr< Features::FaultModels::Temperature::Interface > > &vector)
 
template bool Parameters::get_shared_pointers< Features::FaultModels::Composition::Interface > (const std::string &name, std::vector< std::shared_ptr< Features::FaultModels::Composition::Interface > > &vector)
 
template bool Parameters::get_shared_pointers< Features::FaultModels::Grains::Interface > (const std::string &name, std::vector< std::shared_ptr< Features::FaultModels::Grains::Interface > > &vector)
 
template bool Parameters::get_shared_pointers< Features::FaultModels::Velocity::Interface > (const std::string &name, std::vector< std::shared_ptr< Features::FaultModels::Velocity::Interface > > &vector)
 
template Point< 2 > operator* (const double scalar, const Point< 2 > &point)
 
template Point< 3 > operator* (const double scalar, const Point< 3 > &point)
 
template<unsigned int dim>
Point< dim > operator* (const double scalar, const Point< dim > &point)
 

Detailed Description

The global namespace for the Geodynamic World Builder

Enumeration Type Documentation

◆ CoordinateSystem

This enum lists available coordinate systems that can be used for the function variables. Allowed values are 'cartesian', 'spherical'. 'spherical' coordinates follow: r, phi (2D) or r, phi, theta (3D); where r is radius, phi is longitude, and theta is the polar angle (colatitude).

Enumerator
cartesian 
spherical 
invalid 

Definition at line 31 of file coordinate_system.h.

◆ DepthMethod

There are three ways to look at what should happen when the user gives an angle to go down in a sphere. The first one is the easiest, which is just to tread the system as a Cartesian system. This means taking the angle with the surface tangential at the starting point at the surface everywhere. The advantage is that it is very intuitive and easy to predict what geometry should be produced. This option is called 'angle_at_starting_point_with_surface'. The other end member is that going down with an angle in a sphere should mean that it always goes down with a constant angle relative to the surface tangential at that longitude and latitude. This means a the geometry would a a logarithmic spiral. This option is called 'continuous_angle_with_surface'. Because it is currently to time consuming to implement this option with all the required features, there is an option which approximates this behavior, by using the option 'angle_at_starting_point_with_surface'. This option uses the surface tangential at the beginning of every segment. This means that in the limit of segments going to length zero, this option produces exactly the same geometry as 'continuous_angle_with_surface'.

Enumerator
angle_at_starting_point_with_surface 
angle_at_begin_segment_with_surface 
angle_at_begin_segment_applied_to_end_segment_with_surface 
continuous_angle_with_surface 
none 

Definition at line 57 of file coordinate_system.h.

Function Documentation

◆ operator*() [1/3]

template Point<2> WorldBuilder::operator* ( const double  scalar,
const Point< 2 > &  point 
)

Multiplies a 2d point with a scalar.

◆ operator*() [2/3]

template Point<3> WorldBuilder::operator* ( const double  scalar,
const Point< 3 > &  point 
)

Multiplies a 3d point with a scalar.

◆ operator*() [3/3]

template<unsigned int dim>
Point<dim> WorldBuilder::operator* ( const double  scalar,
const Point< dim > &  point 
)
inline

Definition at line 468 of file point.h.

◆ Parameters::get_shared_pointers< Features::FaultModels::Composition::Interface >()

template bool WorldBuilder::Parameters::get_shared_pointers< Features::FaultModels::Composition::Interface > ( const std::string &  name,
std::vector< std::shared_ptr< Features::FaultModels::Composition::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_shared_pointers< Features::FaultModels::Grains::Interface >()

template bool WorldBuilder::Parameters::get_shared_pointers< Features::FaultModels::Grains::Interface > ( const std::string &  name,
std::vector< std::shared_ptr< Features::FaultModels::Grains::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_shared_pointers< Features::FaultModels::Temperature::Interface >()

template bool WorldBuilder::Parameters::get_shared_pointers< Features::FaultModels::Temperature::Interface > ( const std::string &  name,
std::vector< std::shared_ptr< Features::FaultModels::Temperature::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_shared_pointers< Features::FaultModels::Velocity::Interface >()

template bool WorldBuilder::Parameters::get_shared_pointers< Features::FaultModels::Velocity::Interface > ( const std::string &  name,
std::vector< std::shared_ptr< Features::FaultModels::Velocity::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_shared_pointers< Features::SubductingPlateModels::Composition::Interface >()

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_shared_pointers< Features::SubductingPlateModels::Grains::Interface >()

template bool WorldBuilder::Parameters::get_shared_pointers< Features::SubductingPlateModels::Grains::Interface > ( const std::string &  name,
std::vector< std::shared_ptr< Features::SubductingPlateModels::Grains::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_shared_pointers< Features::SubductingPlateModels::Temperature::Interface >()

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_shared_pointers< Features::SubductingPlateModels::Velocity::Interface >()

template bool WorldBuilder::Parameters::get_shared_pointers< Features::SubductingPlateModels::Velocity::Interface > ( const std::string &  name,
std::vector< std::shared_ptr< Features::SubductingPlateModels::Velocity::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointer< CoordinateSystems::Interface >()

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointer< GravityModel::Interface >()

template std::unique_ptr<GravityModel::Interface> WorldBuilder::Parameters::get_unique_pointer< GravityModel::Interface > ( const std::string &  name)

Returns a vector of pointers to the Gravity Model based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::ContinentalPlateModels::Composition::Interface >()

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::ContinentalPlateModels::Grains::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::ContinentalPlateModels::Grains::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::ContinentalPlateModels::Grains::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::ContinentalPlateModels::Temperature::Interface >()

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::ContinentalPlateModels::Velocity::Interface >()

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::FaultModels::Composition::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::FaultModels::Composition::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::FaultModels::Composition::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::FaultModels::Grains::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::FaultModels::Grains::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::FaultModels::Grains::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::FaultModels::Temperature::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::FaultModels::Temperature::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::FaultModels::Temperature::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::FaultModels::Velocity::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::FaultModels::Velocity::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::FaultModels::Velocity::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::MantleLayerModels::Composition::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::MantleLayerModels::Composition::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::MantleLayerModels::Composition::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::MantleLayerModels::Grains::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::MantleLayerModels::Grains::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::MantleLayerModels::Grains::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::MantleLayerModels::Temperature::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::MantleLayerModels::Temperature::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::MantleLayerModels::Temperature::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::MantleLayerModels::Velocity::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::MantleLayerModels::Velocity::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::MantleLayerModels::Velocity::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::OceanicPlateModels::Composition::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::OceanicPlateModels::Composition::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::OceanicPlateModels::Composition::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::OceanicPlateModels::Grains::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::OceanicPlateModels::Grains::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::OceanicPlateModels::Grains::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::OceanicPlateModels::Temperature::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::OceanicPlateModels::Temperature::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::OceanicPlateModels::Temperature::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::OceanicPlateModels::Velocity::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::OceanicPlateModels::Velocity::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::OceanicPlateModels::Velocity::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::PlumeModels::Composition::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::PlumeModels::Composition::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::PlumeModels::Composition::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::PlumeModels::Grains::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::PlumeModels::Grains::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::PlumeModels::Grains::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::PlumeModels::Temperature::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::PlumeModels::Temperature::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::PlumeModels::Temperature::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::PlumeModels::Velocity::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::PlumeModels::Velocity::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::PlumeModels::Velocity::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::SubductingPlateModels::Composition::Interface >()

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::SubductingPlateModels::Grains::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::SubductingPlateModels::Grains::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::SubductingPlateModels::Grains::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::SubductingPlateModels::Temperature::Interface >()

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.

◆ Parameters::get_unique_pointers< Features::SubductingPlateModels::Velocity::Interface >()

template bool WorldBuilder::Parameters::get_unique_pointers< Features::SubductingPlateModels::Velocity::Interface > ( const std::string &  name,
std::vector< std::unique_ptr< Features::SubductingPlateModels::Velocity::Interface > > &  vector 
)

Todo: Returns a vector of pointers to the Point<3> Type based on the provided name. Note that the variable with this name has to be loaded before this function is called.