shape
#
This module contains a set of factory functions for setting up the shape models of celestial bodies in an environment.
Functions#
|
Factory function for creating spherical body shape model settings. |
Factory function for creating spherical body shape model settings entirely from spice. |
|
|
Factory function for creating oblate spherical body shape model settings. |
- spherical(radius: float) tudatpy.kernel.numerical_simulation.environment_setup.shape.BodyShapeSettings #
Factory function for creating spherical body shape model settings.
Factory function for settings object, defining strictly spherical body shape model entirely from single radius parameter.
- Parameters
radius (float) – Radius specifying spherical body shape.
- Returns
Instance of the
BodyShapeModel
derivedSphericalBodyShapeSettings
class- Return type
Examples
In this example, we create a
BodyShapeModel
using a perfectly spherical shape model:# define parameters describing perfectly spherical model body_radius = 6378.0E3 # create shape model settings body_settings.get( "Earth" ).shape_settings = environment_setup.shape.spherical( body_radius )
- spherical_spice() tudatpy.kernel.numerical_simulation.environment_setup.shape.BodyShapeSettings #
Factory function for creating spherical body shape model settings entirely from spice.
Factory function for settings object, defining spherical body shape model entirely from spice parameters.
- Returns
Instance of
BodyShapeModel
class- Return type
Examples
In this example, we create a
BodyShapeModel
using a perfectly spherical shape model and data from Spice:# create shape model settings body_settings.get( "Earth" ).shape_settings = environment_setup.shape.spherical_spice( )
- oblate_spherical(equatorial_radius: float, flattening: float) tudatpy.kernel.numerical_simulation.environment_setup.shape.BodyShapeSettings #
Factory function for creating oblate spherical body shape model settings.
Factory function for settings object, defining oblate spherical body shape model from equatorial radius and flattening parameter.
- Parameters
- Returns
Instance of the
BodyShapeModel
derivedOblateSphericalBodyShapeSettings
class- Return type
Examples
In this example, we create a
BodyShapeModel
using a perfectly oblate spherical shape model:# define parameters describing oblate spherical model body_radius = 6378.0E3 body_flattening = 1.0 / 300.0 # create shape model settings body_settings.get( "Earth" ).shape_settings = environment_setup.shape.oblate_spherical( body_radius, body_flattening )
Classes#
Base class for providing settings for body shape model. |
|
Class for defining model settings of a strictly spherical body shape. |
|
Class for defining model settings of a oblate spherical body shape. |
- class BodyShapeSettings#
Base class for providing settings for body shape model.
Functional (base) class for settings of body shape models that require no information in addition to their type. Body shape model settings requiring additional information must be defined using an object derived from this class.
- class SphericalBodyShapeSettings#
Class for defining model settings of a strictly spherical body shape.
BodyShapeSettings derived class for strictly spherical body shape model settings.