GridFire 0.0.1a
General Purpose Nuclear Network
Loading...
Searching...
No Matches
Private Member Functions | List of all members
PyPartitionFunction Class Referencefinal

#include <py_partition.h>

Inheritance diagram for PyPartitionFunction:
gridfire::partition::PartitionFunction

Private Member Functions

double evaluate (int z, int a, double T9) const override
 Evaluate the partition function for a given isotope.
 
double evaluateDerivative (int z, int a, double T9) const override
 Evaluate the temperature derivative of the partition function.
 
bool supports (int z, int a) const override
 Check if this partition function supports an isotope.
 
std::string type () const override
 Get the human-readable type of this partition function.
 
std::unique_ptr< gridfire::partition::PartitionFunction > clone () const override
 Create a deep copy of this PartitionFunction.
 

Additional Inherited Members

- Public Member Functions inherited from gridfire::partition::PartitionFunction
virtual ~PartitionFunction ()=default
 Virtual destructor.
 

Detailed Description

Definition at line 9 of file py_partition.h.

Member Function Documentation

◆ clone()

std::unique_ptr< gridfire::partition::PartitionFunction > PyPartitionFunction::clone ( ) const
overrideprivatevirtual

Create a deep copy of this PartitionFunction.

Returns
Unique pointer to a new PartitionFunction instance with identical state.
Postcondition
The caller owns the returned object and must manage its lifetime.

Implements gridfire::partition::PartitionFunction.

Definition at line 50 of file py_partition.cpp.

◆ evaluate()

double PyPartitionFunction::evaluate ( int z,
int a,
double T9 ) const
overrideprivatevirtual

Evaluate the partition function for a given isotope.

Parameters
zProton number (atomic number) of the isotope; must be >= 1.
aMass number of the isotope; must be >= z.
T9Temperature in units of 10^9 K; must be > 0.
Returns
Partition function value (dimensionless) at the specified temperature.
Precondition
Derived implementation supports (z, a) and T9 > 0.
Postcondition
No side effects; pure function.

Implements gridfire::partition::PartitionFunction.

Definition at line 15 of file py_partition.cpp.

◆ evaluateDerivative()

double PyPartitionFunction::evaluateDerivative ( int z,
int a,
double T9 ) const
overrideprivatevirtual

Evaluate the temperature derivative of the partition function.

Computes d/dT (partition function) at the given parameters.

Parameters
zProton number (atomic number) of the isotope; must be >= 1.
aMass number of the isotope; must be >= z.
T9Temperature in units of 10^9 K; must be > 0.
Returns
Temperature derivative of the partition function.
Precondition
Derived implementation supports (z, a) and T9 > 0.
Postcondition
No side effects; pure function.

Implements gridfire::partition::PartitionFunction.

Definition at line 24 of file py_partition.cpp.

◆ supports()

bool PyPartitionFunction::supports ( int z,
int a ) const
overrideprivatevirtual

Check if this partition function supports an isotope.

Parameters
zProton number of the isotope.
aMass number of the isotope.
Returns
true if evaluate and evaluateDerivative can be called for this isotope; false otherwise.
Postcondition
No side effects.

Implements gridfire::partition::PartitionFunction.

Definition at line 33 of file py_partition.cpp.

◆ type()

std::string PyPartitionFunction::type ( ) const
overrideprivatevirtual

Get the human-readable type of this partition function.

Returns
String identifier for the partition function implementation.
Postcondition
No side effects.

Implements gridfire::partition::PartitionFunction.

Definition at line 42 of file py_partition.cpp.

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