Canoe
Comprehensive Atmosphere N' Ocean Engine
CelestrialBody Class Reference

#include <celestrial_body.hpp>

Public Member Functions

 CelestrialBody (ParameterInput *pin)
 
 CelestrialBody (ParameterInput *pin, std::string myname)
 
 ~CelestrialBody ()
 
void ReadSpectraFile (std::string sfile)
 
Direction ParentZenithAngle (Real time, Real colat, Real lon)
 
Real ParentInsolationFlux (Real wav, Real dist_au)
 
Real ParentInsolationFlux (Real wlo, Real whi, Real dist_au)
 
Real ParentDistanceInAu (Real time)
 

Public Attributes

CelestrialBodyparent
 
std::string name
 
Real re
 
Real rp
 
Real obliq
 
Real spinp
 
Real orbit_a
 
Real orbit_e
 
Real orbit_i
 
Real orbit_p
 
Real equinox
 
Real grav_eq
 

Protected Member Functions

void readCelestrialData (ParameterInput *pin, std::string myname)
 

Protected Attributes

float_tripletspec_
 
int nspec_
 
int il_
 

Detailed Description

Definition at line 15 of file celestrial_body.hpp.

Constructor & Destructor Documentation

◆ CelestrialBody() [1/2]

CelestrialBody::CelestrialBody ( ParameterInput *  pin)
explicit

Definition at line 59 of file celestrial_body.cpp.

◆ CelestrialBody() [2/2]

CelestrialBody::CelestrialBody ( ParameterInput *  pin,
std::string  myname 
)

Definition at line 88 of file celestrial_body.cpp.

◆ ~CelestrialBody()

CelestrialBody::~CelestrialBody ( )

Definition at line 116 of file celestrial_body.cpp.

Member Function Documentation

◆ ReadSpectraFile()

void CelestrialBody::ReadSpectraFile ( std::string  sfile)

Definition at line 124 of file celestrial_body.cpp.

◆ ParentZenithAngle()

Direction CelestrialBody::ParentZenithAngle ( Real  time,
Real  colat,
Real  lon 
)

Definition at line 140 of file celestrial_body.cpp.

◆ ParentInsolationFlux() [1/2]

Real CelestrialBody::ParentInsolationFlux ( Real  wav,
Real  dist_au 
)

Definition at line 158 of file celestrial_body.cpp.

◆ ParentInsolationFlux() [2/2]

Real CelestrialBody::ParentInsolationFlux ( Real  wlo,
Real  whi,
Real  dist_au 
)
Todo:
check whether this is correct

Definition at line 167 of file celestrial_body.cpp.

◆ ParentDistanceInAu()

Real CelestrialBody::ParentDistanceInAu ( Real  time)

Definition at line 182 of file celestrial_body.cpp.

◆ readCelestrialData()

void CelestrialBody::readCelestrialData ( ParameterInput *  pin,
std::string  myname 
)
protected

Definition at line 25 of file celestrial_body.cpp.

Member Data Documentation

◆ parent

CelestrialBody* CelestrialBody::parent

Definition at line 18 of file celestrial_body.hpp.

◆ name

std::string CelestrialBody::name

Definition at line 19 of file celestrial_body.hpp.

◆ re

Real CelestrialBody::re

Definition at line 20 of file celestrial_body.hpp.

◆ rp

Real CelestrialBody::rp

Definition at line 21 of file celestrial_body.hpp.

◆ obliq

Real CelestrialBody::obliq

Definition at line 22 of file celestrial_body.hpp.

◆ spinp

Real CelestrialBody::spinp

Definition at line 23 of file celestrial_body.hpp.

◆ orbit_a

Real CelestrialBody::orbit_a

Definition at line 24 of file celestrial_body.hpp.

◆ orbit_e

Real CelestrialBody::orbit_e

Definition at line 25 of file celestrial_body.hpp.

◆ orbit_i

Real CelestrialBody::orbit_i

Definition at line 26 of file celestrial_body.hpp.

◆ orbit_p

Real CelestrialBody::orbit_p

Definition at line 27 of file celestrial_body.hpp.

◆ equinox

Real CelestrialBody::equinox

Definition at line 28 of file celestrial_body.hpp.

◆ grav_eq

Real CelestrialBody::grav_eq

Definition at line 29 of file celestrial_body.hpp.

◆ spec_

float_triplet* CelestrialBody::spec_
protected

Definition at line 46 of file celestrial_body.hpp.

◆ nspec_

int CelestrialBody::nspec_
protected

Definition at line 47 of file celestrial_body.hpp.

◆ il_

int CelestrialBody::il_
protected

Definition at line 48 of file celestrial_body.hpp.


The documentation for this class was generated from the following files: