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

Namespaces

 CoordinateSystems
 
 Features
 
 NaN
 
 Types
 
 Utilities
 

Classes

struct  Data
 
class  Parameters
 
class  Point
 
struct  Version
 
class  World
 

Enumerations

enum  CoordinateSystem { cartesian, spherical, invalid }
 

Functions

template const std::vector< const Types::Double *> Parameters::get_array< const Types::Double > (const std::string &name) const
 
template const std::vector< const Types::Point< 2 > *> Parameters::get_array< const Types::Point< 2 > > (const std::string &name) const
 
template const std::vector< const Types::Point< 3 > *> Parameters::get_array< const Types::Point< 3 > > (const std::string &name) const
 
template<int dim>
Point< dim > operator* (const double scalar, const Point< dim > &point)
 
template Point< 2 > operator* (const double scalar, const Point< 2 > &point)
 
template Point< 3 > operator* (const double scalar, const Point< 3 > &point)
 

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.

Function Documentation

◆ operator*() [1/3]

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

Definition at line 240 of file point.cc.

Here is the call graph for this function:

◆ operator*() [2/3]

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

◆ operator*() [3/3]

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

◆ Parameters::get_array< const Types::Double >()

template const std::vector<const Types::Double * > WorldBuilder::Parameters::get_array< const Types::Double > ( const std::string &  name) const

◆ Parameters::get_array< const Types::Point< 2 > >()

template const std::vector<const Types::Point<2>* > WorldBuilder::Parameters::get_array< const Types::Point< 2 > > ( const std::string &  name) const

◆ Parameters::get_array< const Types::Point< 3 > >()

template const std::vector<const Types::Point<3>* > WorldBuilder::Parameters::get_array< const Types::Point< 3 > > ( const std::string &  name) const