Planet specific workspace methods. More...

#include <cmath>
#include <stdexcept>
#include "agenda_set.h"
#include "arts.h"
#include "arts_constants.h"
#include "arts_conversions.h"
#include "auto_md.h"
#include "check_input.h"
#include "matpack_data.h"
#include "messages.h"

Functions
void	g0Earth (Numeric &g0, const Numeric &lat, const Verbosity &)
	WORKSPACE METHOD: g0Earth.

void	g0Jupiter (Numeric &g0, const Verbosity &)
	WORKSPACE METHOD: g0Jupiter.

void	g0Mars (Numeric &g0, const Verbosity &)
	WORKSPACE METHOD: g0Mars.

void	g0Venus (Numeric &g0, const Verbosity &)
	WORKSPACE METHOD: g0Venus.

void	g0Io (Numeric &g0, const Verbosity &)
	WORKSPACE METHOD: g0Io.

void	refellipsoidEarth (Vector &refellipsoid, const String &model, const Verbosity &)
	WORKSPACE METHOD: refellipsoidEarth.

void	refellipsoidJupiter (Vector &refellipsoid, const String &model, const Verbosity &)
	WORKSPACE METHOD: refellipsoidJupiter.

void	refellipsoidMars (Vector &refellipsoid, const String &model, const Verbosity &)
	WORKSPACE METHOD: refellipsoidMars.

void	refellipsoidMoon (Vector &refellipsoid, const String &model, const Verbosity &)
	WORKSPACE METHOD: refellipsoidMoon.

void	refellipsoidIo (Vector &refellipsoid, const String &model, const Verbosity &)
	WORKSPACE METHOD: refellipsoidIo.

void	refellipsoidEuropa (Vector &refellipsoid, const String &model, const Verbosity &)
	WORKSPACE METHOD: refellipsoidEuropa.

void	refellipsoidGanymede (Vector &refellipsoid, const String &model, const Verbosity &)
	WORKSPACE METHOD: refellipsoidGanymede.

void	refellipsoidVenus (Vector &refellipsoid, const String &model, const Verbosity &)
	WORKSPACE METHOD: refellipsoidVenus.

void	PlanetSet (Workspace &ws, Agenda &g0_agenda, Vector &refellipsoid, Numeric &molarmass_dry_air, Numeric &planet_rotation_period, const String &option, const Verbosity &verbosity)
	WORKSPACE METHOD: PlanetSet.

Variables
constexpr Numeric	EARTH_RADIUS =Constant::earth_radius

constexpr Numeric	DEG2RAD =Conversion::deg2rad(1)

Detailed Description

Planet specific workspace methods.

Author: Patrick Eriksson Patri.nosp@m.ck.E.nosp@m.rikss.nosp@m.on@c.nosp@m.halme.nosp@m.rs.s.nosp@m.e

Date: 2012-03-16

These functions are listed in the doxygen documentation as entries of the file auto_md.h.

Definition in file m_planets.cc.

Function Documentation

◆ g0Earth()

void g0Earth	(	Numeric &	g0,
		const Numeric &	lat,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: g0Earth.

Gravity at zero altitude on Earth.

Sets g0 for the given latitude using a standard parameterisation.

Author: Patrick Eriksson

Parameters

[out]	g0	WS Output
[in]	lat	WS Input

Definition at line 45 of file m_planets.cc.

References DEG2RAD.

Referenced by g0Earth_g().

◆ g0Io()

void g0Io	(	Numeric &	g0,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: g0Io.

Gravity at zero altitude on Io.

Numeric from Wikipedia.

Author: Richard Larsson

Parameters

[out] g0 WS Output

Definition at line 84 of file m_planets.cc.

Referenced by g0Io_g().

◆ g0Jupiter()

void g0Jupiter	(	Numeric &	g0,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: g0Jupiter.

Gravity at zero altitude on Jupiter.

Sets g0 to mean equatorial gravity on Jupiter. Value provided by MPS under ESA-planetary study (TN1).

Author: Jana Mendrok

Parameters

[out] g0 WS Output

Definition at line 64 of file m_planets.cc.

Referenced by g0Jupiter_g().

◆ g0Mars()

void g0Mars	(	Numeric &	g0,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: g0Mars.

Gravity at zero altitude on Mars.

Sets g0 to mean equatorial gravity on Mars. Value provided by MPS under ESA-planetary study (TN1).

Author: Jana Mendrok

Parameters

[out] g0 WS Output

Definition at line 72 of file m_planets.cc.

Referenced by g0Mars_g().

◆ g0Venus()

void g0Venus	(	Numeric &	g0,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: g0Venus.

Gravity at zero altitude on Venus.

Sets g0 to mean equatorial gravity on Venus. Value from Ahrens (1995), provided by MPS under ESA-planetary study (TN1).

Author: Jana Mendrok

Parameters

[out] g0 WS Output

Definition at line 78 of file m_planets.cc.

Referenced by g0Venus_g().

◆ PlanetSet()

void PlanetSet	(	Workspace &	ws,
		Agenda &	g0_agenda,
		Vector &	refellipsoid,
		Numeric &	molarmass_dry_air,
		Numeric &	planet_rotation_period,
		const String &	option,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: PlanetSet.

Sets g0_agenda, refellipsoid, molarmass_dry_air, and planet_rotation_period to default values

g0_agenda* is set using g0_agendaSet with the same option

Note that the default value of isotopologue_ratios is set to "Earth" by default and that we strongly recommend users to update these values if they are using non-Earth atmospheres.

Options are: Earth: Uses refellipsoidEarth with model="Sphere" Sets molarmass_dry_air to 28.966 Sets planet_rotation_period to 86164.1 
 Io: Uses refellipsoidIo with model="Sphere" Sets molarmass_dry_air to 63.110068828000003 Sets planet_rotation_period to 152853 
 Jupiter: Uses refellipsoidJupiter with model="Sphere" Sets molarmass_dry_air to 2.22 Sets planet_rotation_period to 35730 
 Mars: Uses refellipsoidMars with model="Sphere" Sets molarmass_dry_air to 43.34 Sets planet_rotation_period to 88643 
 Venus: Uses refellipsoidVenus with model="Sphere" Sets molarmass_dry_air to 43.45 Sets planet_rotation_period to -2.0997e7

Author: Richard Larsson

Parameters

[in,out]	ws	Workspace
[out]	g0_agenda	WS Output
[out]	refellipsoid	WS Output
[out]	molarmass_dry_air	WS Output
[out]	planet_rotation_period	WS Output
[in]	option	Generic Input

Definition at line 235 of file m_planets.cc.

References AgendaManip::get_g0_agenda(), refellipsoidEarth(), refellipsoidIo(), refellipsoidJupiter(), refellipsoidMars(), and refellipsoidVenus().

Referenced by PlanetSet_g().

◆ refellipsoidEarth()

void refellipsoidEarth	(	Vector &	refellipsoid,
		const String &	model,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: refellipsoidEarth.

Earth reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model the Earth, following different models. The options are:

"Sphere" : A spherical Earth. The radius is set following the value set for the Earth radius in constants.cc.

"WGS84" : The reference ellipsoid used by the GPS system. Should be the standard choice for a non-spherical Earth.

Author: Patrick Eriksson

Parameters

[out]	refellipsoid	WS Output
[in]	model	Generic Input (Default: "Sphere")

Definition at line 90 of file m_planets.cc.

References EARTH_RADIUS.

Referenced by PlanetSet(), and refellipsoidEarth_g().

◆ refellipsoidEuropa()

void refellipsoidEuropa	(	Vector &	refellipsoid,
		const String &	model,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: refellipsoidEuropa.

Io reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Io, folowing different models. The options are:

"Sphere" : A spherical planetesimal. The radius is taken from report of the IAU/IAG Working Group.

Author: Richard Larsson

Parameters

[out]	refellipsoid	WS Output
[in]	model	Generic Input (Default: "Sphere")

Definition at line 189 of file m_planets.cc.

Referenced by refellipsoidEuropa_g().

◆ refellipsoidGanymede()

void refellipsoidGanymede	(	Vector &	refellipsoid,
		const String &	model,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: refellipsoidGanymede.

Ganymede reference ellipsoids.

From Wikipedia

Author: Takayoshi Yamada

Parameters

[out]	refellipsoid	WS Output
[in]	model	Generic Input (Default: "Sphere")

Definition at line 205 of file m_planets.cc.

Referenced by refellipsoidGanymede_g().

◆ refellipsoidIo()

void refellipsoidIo	(	Vector &	refellipsoid,
		const String &	model,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: refellipsoidIo.

Io reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Io, folowing different models. The options are:

"Sphere" : A spherical planetesimal. The radius is taken from report of the IAU/IAG Working Group.

Author: Richard Larsson

Parameters

[out]	refellipsoid	WS Output
[in]	model	Generic Input (Default: "Sphere")

Definition at line 173 of file m_planets.cc.

Referenced by PlanetSet(), and refellipsoidIo_g().

◆ refellipsoidJupiter()

void refellipsoidJupiter	(	Vector &	refellipsoid,
		const String &	model,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: refellipsoidJupiter.

Jupiter reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Jupiter, folowing different models. The options are:

"Sphere" : A spherical planet. The radius is taken from a report of the IAU/IAG Working Group.

"Ellipsoid" : A reference ellipsoid with parameters taken from a report of the IAU/IAG Working Group.

Author: Patrick Eriksson

Parameters

[out]	refellipsoid	WS Output
[in]	model	Generic Input (Default: "Sphere")

Definition at line 110 of file m_planets.cc.

Referenced by PlanetSet(), and refellipsoidJupiter_g().

◆ refellipsoidMars()

void refellipsoidMars	(	Vector &	refellipsoid,
		const String &	model,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: refellipsoidMars.

Mars reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Mars, folowing different models. The options are:

"Sphere" : A spherical planet. The radius is taken from a report of the IAU/IAG Working Group.

"Ellipsoid" : A reference ellipsoid with parameters taken from a report of the IAU/IAG Working Group.

Author: Patrick Eriksson

Parameters

[out]	refellipsoid	WS Output
[in]	model	Generic Input (Default: "Sphere")

Definition at line 130 of file m_planets.cc.

Referenced by PlanetSet(), and refellipsoidMars_g().

◆ refellipsoidMoon()

void refellipsoidMoon	(	Vector &	refellipsoid,
		const String &	model,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: refellipsoidMoon.

Moon reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Moon, folowing different models. The options are:

"Sphere" : A spherical planet. The radius is taken from a report of the IAU/IAG Working Group.

"Ellipsoid" : A reference ellipsoid with parameters taken from Wikepedia (see code for details). The IAU/IAG working group defines the Moon ellipsoid to be a sphere.

Author: Patrick Eriksson

Parameters

[out]	refellipsoid	WS Output
[in]	model	Generic Input (Default: "Sphere")

Definition at line 150 of file m_planets.cc.

Referenced by refellipsoidMoon_g().

◆ refellipsoidVenus()

void refellipsoidVenus	(	Vector &	refellipsoid,
		const String &	model,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: refellipsoidVenus.

Venus reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Venus, folowing different models. The options are:

"Sphere" : A spherical planet. The radius is taken from a report of the IAU/IAG Working Group.

According to the report used above, the Venus ellipsoid lacks eccentricity and no further models should be required.

Author: Patrick Eriksson

Parameters

[out]	refellipsoid	WS Output
[in]	model	Generic Input (Default: "Sphere")

Definition at line 221 of file m_planets.cc.

Referenced by PlanetSet(), and refellipsoidVenus_g().

Variable Documentation

◆ DEG2RAD

constexpr Numeric DEG2RAD =Conversion::deg2rad(1)

inlineconstexpr

Definition at line 32 of file m_planets.cc.

Referenced by g0Earth().

◆ EARTH_RADIUS

constexpr Numeric EARTH_RADIUS =Constant::earth_radius

inlineconstexpr

Definition at line 31 of file m_planets.cc.

Referenced by TelsemAtlas::equare(), and refellipsoidEarth().

Functions

Variables

Detailed Description

Function Documentation

◆ g0Earth()

◆ g0Io()

◆ g0Jupiter()

◆ g0Mars()

◆ g0Venus()

◆ PlanetSet()

◆ refellipsoidEarth()

◆ refellipsoidEuropa()

◆ refellipsoidGanymede()

◆ refellipsoidIo()

◆ refellipsoidJupiter()

◆ refellipsoidMars()

◆ refellipsoidMoon()

◆ refellipsoidVenus()

Variable Documentation

◆ DEG2RAD

◆ EARTH_RADIUS