Stellar Evolution Interface Definition¶
In this chapter we describe the common interface for stellar evolution codes. Currently the interface for stellar evolutions codes that store state of a star is specified. The Stellar Evolution codes that get all the needed state from the function interface (are stateless), are not yet described.
Stellar Evolution codes have at least one specified parameter. Other parameters need
to be specified on a per code basis. All parameters have to be accessed with functions following
the template of the
set_metallicity functions. A parameter access function may only
retrieve or update the value of a single parameter. After all parameters have been set, the
initialize_code function should be called, this gives the code the opportunity prepare the
A number of stellar evolution codes work on star objects. The following methods define the functionality to create, remove and query the particles in the code. Currently the interface does not specify query function for stellar evolution, see stellar evolution for possible direction
To support properties (like acceleration), the code must define
set_ functions. These
functions must get or set one scalar property (1 argument) or a vector property (3 arguments)
Currently only get functions are specified
The stellar evolution codes evolve the properties of the star in time. The following functions are needed to control the evolution in the code.
The state of the code can be queried, before, during and after the model calculations. Currently no specific stellar evolution diagnostics functions have been defined
Some stellar evolution codes can provide services for other codes. Currently no specific stellar evolution service functions have been defined