#include <WsfJacchiaRobertsAtmosphere.hpp>
Public Member Functions | |
| JacchiaRobertsAtmosphere () | |
| JacchiaRobertsAtmosphere (const JacchiaRobertsAtmosphere &aOther)=default | |
| ~JacchiaRobertsAtmosphere () override=default | |
| JacchiaRobertsAtmosphere * | Clone () const override |
| bool | ProcessInput (UtInput &aInput) override |
| double | GetAverageSolarFlux () const |
| Get the average 10.7 cm solar flux (in 10^-22 W/m^2/Hz). | |
| double | GetSolarFlux () const |
| Get the 10.7 cm solar flux (in 10^-22 W/m^2/Hz). | |
| double | GetGeomagneticIndex () const |
| Get the geomagnetic index, K_p. | |
| void | SetAverageSolarFlux (double aF107a) |
| Set the average 10.7 cm solar flux (in 10^-22 W/m^2/Hz). | |
| void | SetSolarFlux (double aF107) |
| Set the 10.7 cm solar flux (in 10^-22 W/m^w/Hz). | |
| void | SetGeomagneticIndex (double aKp) |
| Set the geomagnetic index, K_p. | |
| const char * | GetScriptClassName () const override |
| double | GetDensity (const UtCalendar &aEpoch, const UtLLAPos &aLLA) const override |
| Public Member Functions inherited from wsf::space::Atmosphere | |
| Atmosphere () | |
| Atmosphere (const Atmosphere &aOther)=default | |
| virtual | ~Atmosphere ()=default |
| const ut::CentralBody & | GetCentralBody () const |
| const char * | GetScriptClassName () const override |
| Public Member Functions inherited from WsfObject | |
| WsfObject () | |
| This is the constructor for the WsfObject class. | |
| ~WsfObject () override | |
| This is the destructor for the WsfObject class. | |
| const char * | GetScriptClassName () const override |
| const std::string & | GetType () const |
| WsfStringId | GetTypeId () const |
| Get the string ID of the 'type' of the object. | |
| void | SetType (WsfStringId aType) |
| const std::string & | GetBaseType () const |
| WsfStringId | GetBaseTypeId () const |
| const TypeList & | GetTypeList () const |
| bool | IsA_TypeOf (WsfStringId aType) const |
| WsfObject & | operator= (const WsfObject &aRhs) |
| Assignment operator. | |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| For XIO (de)serialization. | |
| const std::string & | GetName () const |
| WsfStringId | GetNameId () const |
| void | SetName (WsfStringId aName) |
Static Public Attributes | |
| static constexpr const char * | cTYPE {"WSF_JACCHIA_ROBERTS_ATMOSPHERE"} |
Additional Inherited Members | |
| Public Types inherited from WsfObject | |
| typedef std::vector< WsfStringId > | TypeList |
| The list of types returned by GetTypeList. | |
| WsfObject (const WsfObject &aSrc) | |
| Copy constructor (for Clone()). | |
| Protected Attributes inherited from wsf::space::Atmosphere | |
| ut::CloneablePtr< ut::CentralBody > | mCentralBodyPtr |
Detailed Description
The Jacchia-Roberts atmsphere models the exospheric temperature profile, and from that derives the density. This includes effects of solar and geomagnetic activity, as well as diurnal variations.
Constructor & Destructor Documentation
◆ JacchiaRobertsAtmosphere() [1/2]
| wsf::space::JacchiaRobertsAtmosphere::JacchiaRobertsAtmosphere | ( | ) |
References wsf::space::Atmosphere::Atmosphere(), cTYPE, and WsfObject::SetType().
Referenced by Clone(), and JacchiaRobertsAtmosphere().
◆ JacchiaRobertsAtmosphere() [2/2]
|
default |
References JacchiaRobertsAtmosphere().
◆ ~JacchiaRobertsAtmosphere()
|
overridedefault |
Member Function Documentation
◆ Clone()
|
inlineoverridevirtual |
Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.
Implements wsf::space::Atmosphere.
References JacchiaRobertsAtmosphere().
◆ GetAverageSolarFlux()
|
inline |
Get the average 10.7 cm solar flux (in 10^-22 W/m^2/Hz).
◆ GetDensity()
|
overridevirtual |
Return the model density for a given time and location.
This will return the density of the atmosphere (in kg / m^3) at the given aEpoch and given body-centric latitude, longitude and altitude, aLLA. This is the only state variable that subclasses of this class are required to implement.
- Parameters
-
aEpoch The date and time at which the density is being queried. aLLA The body-centric latitude, longitude and altitude at which the density is being queried.
- Returns
- The density (in kg / m^3).
Implements wsf::space::Atmosphere.
◆ GetGeomagneticIndex()
|
inline |
Get the geomagnetic index, K_p.
◆ GetScriptClassName()
|
inlineoverride |
◆ GetSolarFlux()
|
inline |
Get the 10.7 cm solar flux (in 10^-22 W/m^2/Hz).
◆ ProcessInput()
|
overridevirtual |
Process input from a generic source.
Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.
- Parameters
-
aInput a reference to a UtInput object.
- Returns
- 'true' if the command was one recognized by the class or 'false' if not.
- Exceptions
-
UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.
- Note
- If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.
Reimplemented from wsf::space::Atmosphere.
References wsf::space::Atmosphere::ProcessInput().
◆ SetAverageSolarFlux()
|
inline |
Set the average 10.7 cm solar flux (in 10^-22 W/m^2/Hz).
◆ SetGeomagneticIndex()
|
inline |
Set the geomagnetic index, K_p.
◆ SetSolarFlux()
|
inline |
Set the 10.7 cm solar flux (in 10^-22 W/m^w/Hz).
Member Data Documentation
◆ cTYPE
|
staticconstexpr |
Referenced by wsf::space::AtmosphereTypes::AtmosphereTypes(), and JacchiaRobertsAtmosphere().
The documentation for this class was generated from the following files: