BSMPT::Phase Struct Reference

Phase object. More...

#include <BSMPT/minimum_tracer/minimum_tracer.h>

Public Member Functions
void	Add (Minimum min)
	Function that adds min to MinimumPhaseVector.
Minimum	Get (double T)
	Calculates the minimum of the phase at temperature T. This function assumes that T is inside the temperature range of the phase.
	Phase ()
	empty constructor
	Phase (const std::vector< double > &phase_start, const double &initialT, const double &finalT, double &globMinEndT, std::shared_ptr< MinimumTracer > &MinTracerIn)
	Construct a new Phase object with enforced global minimum tracing.
	Phase (const double &initialT, const std::vector< double > &phase_start, const double &LowT, const double &HighT, double &globMinEndT, std::shared_ptr< MinimumTracer > &MinTracerIn)
	Construct a new Phase:: Phase object.
	Phase (const std::vector< double > &phase_start, const double &initialT, const double &finalT, std::shared_ptr< MinimumTracer > &MinTracerIn)
	Construct a new Phase object.
	Phase (const double &initialT, const std::vector< double > &phase_start, const double &LowT, const double &HighT, std::shared_ptr< MinimumTracer > &MinTracerIn)
	Construct a new Phase:: Phase object.
	Phase (const double &initialT, const double &LowT, const double &HighT, std::shared_ptr< MinimumTracer > &MinTracerIn)
	Construct a new Phase:: Phase object.

Public Attributes
int	id = 0
	phase ID
double	T_low = 0
	Lowest temperature of the phase.
double	T_high = 0
	Highest temperature of the phase.
std::vector< Minimum >	MinimumPhaseVector
	Set of Minimum that compose the phase.
std::shared_ptr< MinimumTracer >	MinTracer
	MinTracer object.

Detailed Description

Phase object.

Constructor & Destructor Documentation

Phase() [1/5]

BSMPT::Phase::Phase	(	const std::vector< double > &	phase_start,
		const double &	initialT,
		const double &	finalT,
		double &	globMinEndT,
		std::shared_ptr< MinimumTracer > &	MinTracerIn
	)

Construct a new Phase object with enforced global minimum tracing.

Parameters

phase_start	Initial starting point for the phase
initialT	Initial temperature
finalT	Final temperature
globMinEndT	Temperature where phase is first detected to no longer be global minimum
MinTracerIn	MinTracer pointer

Phase() [2/5]

BSMPT::Phase::Phase	(	const double &	initialT,
		const std::vector< double > &	phase_start,
		const double &	LowT,
		const double &	HighT,
		double &	globMinEndT,
		std::shared_ptr< MinimumTracer > &	MinTracerIn
	)

Construct a new Phase:: Phase object.

Parameters

phase_start	Initial starting point for the phase
initialT	Temperature of the phase given as input
LowT	Lowest temperature
HighT	Highest temperature
globMinEndT	Temperature where phase is first detected to no longer be global minimum
MinTracerIn	MinTracer pointer

Phase() [3/5]

BSMPT::Phase::Phase	(	const std::vector< double > &	phase_start,
		const double &	initialT,
		const double &	finalT,
		std::shared_ptr< MinimumTracer > &	MinTracerIn
	)

Construct a new Phase object.

Parameters

phase_start	Initial starting point for the phase
initialT	Initial temperature
finalT	Final temperature
globMinEndT	Temperature where phase is first detected to no longer be global minimum
MinTracerIn	MinTracer pointer

Phase() [4/5]

BSMPT::Phase::Phase	(	const double &	initialT,
		const std::vector< double > &	phase_start,
		const double &	LowT,
		const double &	HighT,
		std::shared_ptr< MinimumTracer > &	MinTracerIn
	)

Construct a new Phase:: Phase object.

Parameters

phase_start	Initial starting point for the phase
initialT	Temperature of the phase given as input
LowT	Lowest temperature
HighT	Highest temperature
MinTracerIn	MinTracer pointer

Phase() [5/5]

BSMPT::Phase::Phase	(	const double &	initialT,
		const double &	LowT,
		const double &	HighT,
		std::shared_ptr< MinimumTracer > &	MinTracerIn
	)

Construct a new Phase:: Phase object.

Parameters

initialT	Temperature of the phase given as input
LowT	Lowest temperature
HighT	Highest temperature
MinTracerIn	MinTracer pointer

Member Function Documentation

Add()

void BSMPT::Phase::Add

(

Minimum

min

)

Function that adds min to MinimumPhaseVector.

Parameters

min

Minimum

Get()

Minimum BSMPT::Phase::Get

(

double

T

)

Calculates the minimum of the phase at temperature T. This function assumes that T is inside the temperature range of the phase.

Parameters

T	temperature

Returns

Minimum at temperature T for the corresponding phase

---

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

• include/BSMPT/minimum_tracer/minimum_tracer.h
• src/minimum_tracer/minimum_tracer.cpp