Oblique20LinearQuantity Class Reference

A function of the stellar angular momentum expected to evolve linearly with time under the m = 1, m' = 0 term. More...

#include <Oblique20LinearQuantity.h>

Inheritance diagram for Oblique20LinearQuantity:

Collaboration diagram for Oblique20LinearQuantity:

Public Member Functions
	Oblique20LinearQuantity (double total_angmom, double orbital_angmom, double initial_star_angmom)
double	operator() (double star_angmom) 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 star_angmom) 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	indefinite_integral (double star_angmom) const
	Return the real part of the indefinite integral of the inverse of the rate of change of the stellar angular momentum. More...

Private Attributes
double	__total_angmom
	The Magnitude of the total angular momentum in the system in units of the orbital angular momentum (conserved). More...
double	__initial_star_angmom
	The Magnitude of the initial stellar spin angular momentum in. More...
double	__angmom_scale
	The initial orbital angular momentum (everything is scaled by this quantity). More...
double	__initial_indefinite_integral
	The value of indefinite integral(__initial_star_angmom) More...

Detailed Description

A function of the stellar angular momentum expected to evolve linearly with time under the m = 1, m' = 0 term.

Definition at line 18 of file Oblique20LinearQuantity.h.

Member Function Documentation

crossings()

Core::InterpSolutionIterator Oblique20LinearQuantity::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 52 of file Oblique20LinearQuantity.h.

deriv()

const Core::FunctionDerivatives * Oblique20LinearQuantity::deriv ( double  star_angmom ) const

virtual

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 62 of file Oblique20LinearQuantity.cpp.

indefinite_integral()

double Oblique20LinearQuantity::indefinite_integral ( double  star_angmom ) const

private

Return the real part of the indefinite integral of the inverse of the rate of change of the stellar angular momentum.

Definition at line 10 of file Oblique20LinearQuantity.cpp.

operator()()

double Oblique20LinearQuantity::operator() ( double  in_value ) const

virtual

The value of the function at the given abscissa.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 55 of file Oblique20LinearQuantity.cpp.

range_high()

double Oblique20LinearQuantity::range_high ( ) const

inlinevirtual

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

Implements Core::OneArgumentFunction< double, double >.

Definition at line 47 of file Oblique20LinearQuantity.h.

range_low()

double Oblique20LinearQuantity::range_low ( ) const

inlinevirtual

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

Implements Core::OneArgumentFunction< double, double >.

Definition at line 48 of file Oblique20LinearQuantity.h.

Member Data Documentation

__angmom_scale

double Oblique20LinearQuantity::__angmom_scale

private

The initial orbital angular momentum (everything is scaled by this quantity).

Definition at line 23 of file Oblique20LinearQuantity.h.

__initial_indefinite_integral

double Oblique20LinearQuantity::__initial_indefinite_integral

private

The value of indefinite integral(__initial_star_angmom)

Definition at line 23 of file Oblique20LinearQuantity.h.

__initial_star_angmom

double Oblique20LinearQuantity::__initial_star_angmom

private

The Magnitude of the initial stellar spin angular momentum in.

Definition at line 23 of file Oblique20LinearQuantity.h.

__total_angmom

double Oblique20LinearQuantity::__total_angmom

private

The Magnitude of the total angular momentum in the system in units of the orbital angular momentum (conserved).

Definition at line 23 of file Oblique20LinearQuantity.h.

---

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

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