ConservedLERadObliquityEvolution Class Reference

Inheritance diagram for ConservedLERadObliquityEvolution:

Collaboration diagram for ConservedLERadObliquityEvolution:

Public Member Functions
	ConservedLERadObliquityEvolution (const Core::OneArgumentDiffFunction &lconv_evol, const ConservedLEConvObliquityEvolution &conv_obliq_evol, double orbital_angmom, double disk_lifetime)
double	operator() (double age) const
	The value of the function at the given abscissa. More...
double	range_high () const
	The lower end of the range over which the function is defined. More...
double	range_low () const
	The upper end of the range over which the function is defined. More...
Core::InterpSolutionIterator	crossings (double=0) const
	An iterator over the abscissas where the function takes the given y value. More...
const Core::FunctionDerivatives *	deriv (double) const
	Returns a pointer to the derivative of the function. More...
Public Member Functions inherited from Core::OneArgumentFunction< double, double >
virtual	~OneArgumentFunction ()
	Provide a virtual destructor for a virtual class. More...

Private Member Functions
double	value (double lconv, double conv_obliq) const
	The radiative zone obliquity for the given parameters. More...

Private Attributes
const Core::OneArgumentDiffFunction &	__lconv_evol
	The evolution of the convective zone angular momentum. More...
const ConservedLEConvObliquityEvolution &	__conv_obliq_evol
	The evolution of the convective zone obliquity. More...
double	__orbital_angmom
	The orbital angular momentum magnitude (does not evolve). More...
double	__initial_obliquity
	The obliquity at the time the disk dissipates. More...
double	__initial_lconv_perp
	The initial component of the convective zone angular momentum perpendicular to the orbital angular momentum. More...
double	__disk_lifetime
	See ConservedLEConvObliquityEvolution::__disk_lifetime. More...

Detailed Description

Definition at line 108 of file ConservedLEObliquityEvolution.h.

Constructor & Destructor Documentation

ConservedLERadObliquityEvolution()

ConservedLERadObliquityEvolution::ConservedLERadObliquityEvolution ( const Core::OneArgumentDiffFunction &  lconv_evol, const ConservedLEConvObliquityEvolution &  conv_obliq_evol, double  orbital_angmom, double  disk_lifetime  )

inline

Parameters

lconv_evol	See __lconv_evol member.
conv_obliq_evol	See __conv_obliq_evol member.
orbital_angmom	See __orbital_angmom member.
disk_lifetime	See ConservedLEConvObliquityEvolution::__disk_lifetime.

Definition at line 164 of file ConservedLEObliquityEvolution.h.

Member Function Documentation

crossings()

Core::InterpSolutionIterator ConservedLERadObliquityEvolution::crossings ( double  = 0 ) const

inlinevirtual

An iterator over the abscissas where the function takes the given y value.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 201 of file ConservedLEObliquityEvolution.h.

deriv()

const Core::FunctionDerivatives* ConservedLERadObliquityEvolution::deriv ( double  ) const

inlinevirtual

Returns a pointer to the derivative of the function.

Result must be deleted when no longer needed.

The use of a pointer allows avoiding potentially expensive copy opertaions.

Implements Core::OneArgumentDiffFunction.

Definition at line 214 of file ConservedLEObliquityEvolution.h.

operator()()

double ConservedLERadObliquityEvolution::operator() ( double  in_value ) const

inlinevirtual

The value of the function at the given abscissa.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 187 of file ConservedLEObliquityEvolution.h.

range_high()

double ConservedLERadObliquityEvolution::range_high ( ) const

inlinevirtual

The lower end of the range over which the function is defined.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 194 of file ConservedLEObliquityEvolution.h.

range_low()

double ConservedLERadObliquityEvolution::range_low ( ) const

inlinevirtual

The upper end of the range over which the function is defined.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 196 of file ConservedLEObliquityEvolution.h.

value()

double ConservedLERadObliquityEvolution::value ( double  lconv, double  conv_obliq  ) const

inlineprivate

The radiative zone obliquity for the given parameters.

Parameters

lconv	The convective zone angular momentum magnitude.
conv_obliq	The convective zone obliqity

Definition at line 130 of file ConservedLEObliquityEvolution.h.

Member Data Documentation

__conv_obliq_evol

const ConservedLEConvObliquityEvolution& ConservedLERadObliquityEvolution::__conv_obliq_evol

private

The evolution of the convective zone obliquity.

Definition at line 114 of file ConservedLEObliquityEvolution.h.

__disk_lifetime

double ConservedLERadObliquityEvolution::__disk_lifetime

private

See ConservedLEConvObliquityEvolution::__disk_lifetime.

Definition at line 127 of file ConservedLEObliquityEvolution.h.

__initial_lconv_perp

double ConservedLERadObliquityEvolution::__initial_lconv_perp

private

The initial component of the convective zone angular momentum perpendicular to the orbital angular momentum.

Definition at line 124 of file ConservedLEObliquityEvolution.h.

__initial_obliquity

double ConservedLERadObliquityEvolution::__initial_obliquity

private

The obliquity at the time the disk dissipates.

Definition at line 120 of file ConservedLEObliquityEvolution.h.

__lconv_evol

const Core::OneArgumentDiffFunction& ConservedLERadObliquityEvolution::__lconv_evol

private

The evolution of the convective zone angular momentum.

Definition at line 111 of file ConservedLEObliquityEvolution.h.

__orbital_angmom

double ConservedLERadObliquityEvolution::__orbital_angmom

private

The orbital angular momentum magnitude (does not evolve).

Definition at line 117 of file ConservedLEObliquityEvolution.h.

---

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

• /home/kpenev/projects/git/poet/poet_src/unit_tests/testEvolve/ConservedLEObliquityEvolution.h