ConservedLEConvObliquityEvolution Class Reference

Inheritance diagram for ConservedLEConvObliquityEvolution:

Collaboration diagram for ConservedLEConvObliquityEvolution:

Public Member Functions
	ConservedLEConvObliquityEvolution (const Core::OneArgumentDiffFunction &lconv_evol, double orbital_angmom, double total_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 age) 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) const
	The value of the obliquity for the given convective angular momentum. More...

Private Attributes
const Core::OneArgumentDiffFunction &	__lconv_evol
	The evolution of the convective zone angular momentum. More...
double	__orbital_angmom
	The orbital angular momentum (does not evolve). More...
double	__total2_minus_orbital2
double	__disk_lifetime
	The lifetime to assume for the disk before evolution starts. More...

Detailed Description

Definition at line 16 of file ConservedLEObliquityEvolution.h.

Constructor & Destructor Documentation

ConservedLEConvObliquityEvolution()

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

inline

Parameters

lconv_evol	See __lconv_evol member.
orbital_angmom	See __orbital_angmom member.
total_angmom	The total angular momentum in the system (does not evolve).
disk_lifetime	See __disk_lifetime member.

Definition at line 40 of file ConservedLEObliquityEvolution.h.

Member Function Documentation

crossings()

Core::InterpSolutionIterator ConservedLEConvObliquityEvolution::crossings ( double  y = 0 ) const

inlinevirtual

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

Implements Core::OneArgumentFunction< double, double >.

Definition at line 71 of file ConservedLEObliquityEvolution.h.

deriv()

const Core::FunctionDerivatives* ConservedLEConvObliquityEvolution::deriv ( double  age ) 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 85 of file ConservedLEObliquityEvolution.h.

operator()()

double ConservedLEConvObliquityEvolution::operator() ( double  in_value ) const

inlinevirtual

The value of the function at the given abscissa.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 61 of file ConservedLEObliquityEvolution.h.

range_high()

double ConservedLEConvObliquityEvolution::range_high ( ) const

inlinevirtual

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

Implements Core::OneArgumentFunction< double, double >.

Definition at line 68 of file ConservedLEObliquityEvolution.h.

range_low()

double ConservedLEConvObliquityEvolution::range_low ( ) const

inlinevirtual

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

Implements Core::OneArgumentFunction< double, double >.

Definition at line 69 of file ConservedLEObliquityEvolution.h.

value()

double ConservedLEConvObliquityEvolution::value ( double  lconv ) const

inlineprivate

The value of the obliquity for the given convective angular momentum.

Definition at line 32 of file ConservedLEObliquityEvolution.h.

Member Data Documentation

__disk_lifetime

double ConservedLEConvObliquityEvolution::__disk_lifetime

private

The lifetime to assume for the disk before evolution starts.

Definition at line 29 of file ConservedLEObliquityEvolution.h.

__lconv_evol

const Core::OneArgumentDiffFunction& ConservedLEConvObliquityEvolution::__lconv_evol

private

The evolution of the convective zone angular momentum.

Definition at line 19 of file ConservedLEObliquityEvolution.h.

__orbital_angmom

double ConservedLEConvObliquityEvolution::__orbital_angmom

private

The orbital angular momentum (does not evolve).

Definition at line 22 of file ConservedLEObliquityEvolution.h.

__total2_minus_orbital2

double ConservedLEConvObliquityEvolution::__total2_minus_orbital2

private

The difference between the squares of the total and orbital angular momenta.

Definition at line 26 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