#include <wrapper_cpp.h>

Public Member Functions
	WorldBuilderWrapper (std::string filename, bool has_output_dir=false, const std::string &output_dir="", const unsigned long random_number_seed=1.0)

	~WorldBuilderWrapper ()

double	temperature_2d (double x, double z, double depth)

double	temperature_3d (double x, double y, double z, double depth)

double	temperature_2d (double x, double z, double depth, double gravity)

double	temperature_3d (double x, double y, double z, double depth, double gravity)

double	composition_2d (double x, double z, double depth, unsigned int composition_number)

double	composition_3d (double x, double y, double z, double depth, unsigned int composition_number)

Private Attributes
void *	ptr_ptr_world

Detailed Description

This class is to be used by SWIG. To make it easy for SWIG we do not use any other world builder header file in this header file. This means that the class stores a void pointer internally. The cpp implementation can use the world builder header files.

Definition at line 34 of file wrapper_cpp.h.

Constructor & Destructor Documentation

◆ WorldBuilderWrapper()

wrapper_cpp::WorldBuilderWrapper::WorldBuilderWrapper	(	std::string	filename,
		bool	has_output_dir = `false`,
		const std::string &	output_dir = `""`,
		const unsigned long	random_number_seed = `1.0`
	)

constructor

Definition at line 27 of file wrapper_cpp.cc.

◆ ~WorldBuilderWrapper()

wrapper_cpp::WorldBuilderWrapper::~WorldBuilderWrapper ( )

destructor

Definition at line 35 of file wrapper_cpp.cc.

Member Function Documentation

◆ composition_2d()

double wrapper_cpp::WorldBuilderWrapper::composition_2d	(	double	x,
		double	z,
		double	depth,
		unsigned int	composition_number
	)

This function return the composition at a specific location given x, z, depth and composition number.

Definition at line 66 of file wrapper_cpp.cc.

◆ composition_3d()

double wrapper_cpp::WorldBuilderWrapper::composition_3d	(	double	x,
		double	y,
		double	z,
		double	depth,
		unsigned int	composition_number
	)

This function return the composition at a specific location given x, y, z, depth and composition number.

Definition at line 72 of file wrapper_cpp.cc.

◆ temperature_2d() [1/2]

double wrapper_cpp::WorldBuilderWrapper::temperature_2d	(	double	x,
		double	z,
		double	depth
	)

This function return the temperature at a specific location given x, z, depth and gravity.

Definition at line 43 of file wrapper_cpp.cc.

Here is the caller graph for this function:

◆ temperature_2d() [2/2]

double wrapper_cpp::WorldBuilderWrapper::temperature_2d	(	double	x,
		double	z,
		double	depth,
		double	gravity
	)

DEPRECATED: Replaced by a temperature function without the gravity. This function will be removed in future versions. This function return the temperature at a specific location given x, z, depth and gravity. Note: gravity value is no longer used, instead use the gravity model from the input file.

Definition at line 50 of file wrapper_cpp.cc.

Here is the call graph for this function:

◆ temperature_3d() [1/2]

double wrapper_cpp::WorldBuilderWrapper::temperature_3d	(	double	x,
		double	y,
		double	z,
		double	depth
	)

This function return the temperature at a specific location given x, y, z, depth and gravity.

Definition at line 55 of file wrapper_cpp.cc.

Here is the caller graph for this function:

◆ temperature_3d() [2/2]

double wrapper_cpp::WorldBuilderWrapper::temperature_3d	(	double	x,
		double	y,
		double	z,
		double	depth,
		double	gravity
	)

DEPRECATED: Replaced by a temperature function without the gravity. This function will be removed in future versions. This function return the temperature at a specific location given x, y, z, depth and gravity. Note: gravity value is no longer used, instead use the gravity model from the input file.

Definition at line 61 of file wrapper_cpp.cc.

Here is the call graph for this function:

Member Data Documentation

◆ ptr_ptr_world

void* wrapper_cpp::WorldBuilderWrapper::ptr_ptr_world

private

Definition at line 89 of file wrapper_cpp.h.

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

include/world_builder/wrapper_cpp.h
source/world_builder/wrapper_cpp.cc

Public Member Functions

Private Attributes