StellarEvolution::SumDerivatives Class Reference

Derivative class for a quantity that is the sum of two other quantities. More...

#include <SumDerivatives.h>

Inheritance diagram for StellarEvolution::SumDerivatives:

Collaboration diagram for StellarEvolution::SumDerivatives:

Public Member Functions
	SumDerivatives (const FunctionDerivatives *derivative1, const FunctionDerivatives *derivative2, bool delete_inputs=true)
	Create a derivative object for a sum of two quantities: q1+q2. More...
double	order (unsigned deriv_order=1) const
	The deriv_order-th derivative. More...
	~SumDerivatives ()
	Clean up. More...
Public Member Functions inherited from Core::FunctionDerivatives
virtual	~FunctionDerivatives ()
	Clean up. More...

Private Attributes
const FunctionDerivatives *	q1_deriv
	The derivatives of the first quantity in the sum. More...
const FunctionDerivatives *	q2_deriv
	The derivatives of the second quantity in the sum. More...
bool	destroy_derivs
	Whether to delete the input derivative when the object is destroyed. More...

Detailed Description

Derivative class for a quantity that is the sum of two other quantities.

Definition at line 21 of file SumDerivatives.h.

Constructor & Destructor Documentation

SumDerivatives()

StellarEvolution::SumDerivatives::SumDerivatives ( const FunctionDerivatives *  derivative1, const FunctionDerivatives *  derivative2, bool  delete_inputs = true  )

inline

Create a derivative object for a sum of two quantities: q1+q2.

Parameters

derivative1	Pointer to the derivative of the first quantity (q1).
derivative2	Pointer to the derivative of the second quantity (q2).
delete_inputs	Delete the input derivatives on destruction?

Definition at line 34 of file SumDerivatives.h.

~SumDerivatives()

StellarEvolution::SumDerivatives::~SumDerivatives ( )

inline

Clean up.

Definition at line 51 of file SumDerivatives.h.

Member Function Documentation

order()

double StellarEvolution::SumDerivatives::order ( unsigned  deriv_order = 1 ) const

inlinevirtual

The deriv_order-th derivative.

Implements Core::FunctionDerivatives.

Definition at line 47 of file SumDerivatives.h.

Member Data Documentation

destroy_derivs

bool StellarEvolution::SumDerivatives::destroy_derivs

private

Whether to delete the input derivative when the object is destroyed.

Definition at line 31 of file SumDerivatives.h.

q1_deriv

const FunctionDerivatives* StellarEvolution::SumDerivatives::q1_deriv

private

The derivatives of the first quantity in the sum.

Definition at line 24 of file SumDerivatives.h.

q2_deriv

const FunctionDerivatives * StellarEvolution::SumDerivatives::q2_deriv

private

The derivatives of the second quantity in the sum.

Definition at line 24 of file SumDerivatives.h.

---

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

• /home/kpenev/projects/git/poet/poet_src/StellarEvolution/SumDerivatives.h