`mass_rate`¶

Here, you will find a list of all mass rate models available in Tudat, which are needed when propagating the mass of a body numerically (for instance for a spacecraft under thrust). Some more specifics on this, and the overall interaction with Tudat, can be found on the user guide .

The functions here all create settings objects for mass rate models that are provided as input to the create_mass_rate_models() function. The functions in this submodule create objects of type MassRateModelSettings or (in case more information than only the type of mass rate is needed to create the model), one of its derived classes.

Functions¶

`from_thrust`([use_all_thrust_models, ...])	Creates the settings for a mass rate model defined from a thrust model.
`custom_mass_rate`(mass_rate_function)	Creates the settings for a mass rate model defined from a thrust model.

from_thrust(use_all_thrust_models: bool = 1, associated_thrust_source: str = '') → tudatpy.kernel.dynamics.propagation_setup.mass_rate.MassRateModelSettings¶

Creates the settings for a mass rate model defined from a thrust model.

Creates the settings for a mass rate model defined from a thrust model. The mass rate model is derived from the associated body’s engine model. It is possible to consider only a specific engine or all engines.

Parameters:

use_all_thrust_models (bool, default=true) – Denotes whether all engines of the associated body are to be combined into a single thrust model.
associated_thrust_source (str, default="") – Name of engine model from which thrust is to be derived (must be empty if the first argument is set to true).

Returns:

From thrust mass rate settings object.

Return type:

FromThrustMassRateSettings

custom_mass_rate(mass_rate_function: Callable[[float | SupportsIndex], float]) → tudatpy.kernel.dynamics.propagation_setup.mass_rate.MassRateModelSettings¶

Creates the settings for a mass rate model defined from a thrust model.

Creates the settings for a custom mass rate model defined through a mass rate function. The function must have time as an independent variable.

NOTE: the mass_rate_function is called with a NaN input at the start of each function evaluation of the full state derivative. This signals the start of a new evaluation and can be used to make custom models more efficient if multiple (related) custom functions are implemented in a single class custom model user guide. However, this does require that calling the mass_rate_function with NaN input does not result in an exception.

Parameters:: mass_rate_function (callable[[Time], float]) – Function of time defining the custom mass rate.
Returns:: Custom mass rate settings object.
Return type:: CustomMassRateSettings

Enumerations¶

AvailableMassRateModels

Enumeration of available mass rate models.

class AvailableMassRateModels¶

Bases: pybind11_object

Enumeration of available mass rate models.

Enumeration of mass rate models supported by tudat.

Members:

undefined_mass_rate_type :

custom_mass_rate_type :

from_thrust_mass_rate_type :

AvailableMassRateModels.name -> str

Classes¶

`MassRateModelSettings`	Functional base class to define settings for mass rates.
`FromThrustMassRateSettings`	MassRateModelSettings-derived class to define settings for a mass rate model derived from a thrust model.
`CustomMassRateSettings`	MassRateModelSettings-derived class to define settings for a custom mass rate model.

class MassRateModelSettings¶

Bases: pybind11_object

Functional base class to define settings for mass rates.

Base class for providing settings for a mass rate model, that defines the models to be used to numerically propagate the mass of a body during a simulation. If any additional information (besides the type of the mass rate model) is required, these must be implemented in a derived class (dedicated for each mass rate model type).

class FromThrustMassRateSettings¶

Bases: MassRateModelSettings

MassRateModelSettings-derived class to define settings for a mass rate model derived from a thrust model.

class CustomMassRateSettings¶