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

#include <utilities.h>

Public Member Functions

 NaturalCoordinate (const std::array< double, 3 > &position, const ::WorldBuilder::CoordinateSystems::Interface &coordinate_system)
 
 NaturalCoordinate (const Point< 3 > &position, const ::WorldBuilder::CoordinateSystems::Interface &coordinate_system)
 
const std::array< double, 3 > & get_coordinates ()
 
const std::array< double, 2 > get_surface_coordinates () const
 
double get_depth_coordinate () const
 

Detailed Description

Definition at line 64 of file utilities.h.

Constructor & Destructor Documentation

◆ NaturalCoordinate() [1/2]

WorldBuilder::Utilities::NaturalCoordinate::NaturalCoordinate ( const std::array< double, 3 > &  position,
const ::WorldBuilder::CoordinateSystems::Interface coordinate_system 
)

Constructor based on providing the geometry model as a pointer

Here is the caller graph for this function:

◆ NaturalCoordinate() [2/2]

WorldBuilder::Utilities::NaturalCoordinate::NaturalCoordinate ( const Point< 3 > &  position,
const ::WorldBuilder::CoordinateSystems::Interface coordinate_system 
)

Constructor based on providing the geometry model as a pointer

Member Function Documentation

◆ get_coordinates()

const std::array< double, 3 > & WorldBuilder::Utilities::NaturalCoordinate::get_coordinates ( )

Returns the coordinates in the given coordinate system, which may not be Cartesian.

Definition at line 210 of file utilities.cc.

◆ get_depth_coordinate()

double WorldBuilder::Utilities::NaturalCoordinate::get_depth_coordinate ( ) const

The coordinate that represents the 'depth' direction in the chosen coordinate system.

Definition at line 264 of file utilities.cc.

◆ get_surface_coordinates()

const std::array< double, 2 > WorldBuilder::Utilities::NaturalCoordinate::get_surface_coordinates ( ) const

The coordinate that represents the 'surface' directions in the chosen coordinate system.

Definition at line 240 of file utilities.cc.

Here is the caller graph for this function:

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