eos_config.hpp File Reference

#include "shambackends/sycl.hpp"
#include "shamunits/Constants.hpp"
#include "shamunits/UnitSystem.hpp"

Include dependency graph for eos_config.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	shamphys::EOS_Config_Isothermal< Tscal >
	Configuration struct for isothermal equation of state. More...
struct	shamphys::EOS_Config_Adiabatic< Tscal >
	Configuration struct for adiabatic equation of state. More...
struct	shamphys::EOS_Config_Polytropic< Tscal >
	Configuration struct for polytropic equation of state. More...
struct	shamphys::EOS_Config_Fermi< Tscal >
	Configuration struct for Fermi equation of state. More...
struct	shamphys::EOS_Config_LocallyIsothermal_LP07< Tscal >
	Configuration struct for the locally isothermal equation of state from Lodato Price 2007. More...
struct	shamphys::EOS_Config_LocallyIsothermalDisc_Farris2014< Tscal >
	Configuration struct for the locally isothermal equation of state from Farris 2014. More...
struct	shamphys::EOS_Config_LocallyIsothermalDisc_ExtendedFarris2014< Tscal >
	Configuration struct for the locally isothermal equation of state extended from Farris 2014 to include for the q index of the disc. More...

Functions
template<class Tscal >
bool	shamphys::operator== (const EOS_Config_Adiabatic< Tscal > &lhs, const EOS_Config_Adiabatic< Tscal > &rhs)
	Equal operator for the EOS_Config_Adiabatic struct.
template<class Tscal >
bool	shamphys::operator== (const EOS_Config_Polytropic< Tscal > &lhs, const EOS_Config_Polytropic< Tscal > &rhs)
	Equal operator for the EOS_Config_Polytropic struct.
template<class Tscal >
bool	shamphys::operator== (const EOS_Config_Fermi< Tscal > &lhs, const EOS_Config_Fermi< Tscal > &rhs)
	Equal operator for the EOS_Config_Fermi struct.
template<class Tscal >
bool	shamphys::operator== (const EOS_Config_LocallyIsothermal_LP07< Tscal > &lhs, const EOS_Config_LocallyIsothermal_LP07< Tscal > &rhs)
	Equal operator for the EOS_Config_LocallyIsothermal_LP07 struct.
template<class Tscal >
bool	shamphys::operator== (const EOS_Config_LocallyIsothermalDisc_Farris2014< Tscal > &lhs, const EOS_Config_LocallyIsothermalDisc_Farris2014< Tscal > &rhs)
	Equal operator for the EOS_Config_LocallyIsothermalDisc_Farris2014 struct.
template<class Tscal >
bool	shamphys::operator== (const EOS_Config_LocallyIsothermalDisc_ExtendedFarris2014< Tscal > &lhs, const EOS_Config_LocallyIsothermalDisc_ExtendedFarris2014< Tscal > &rhs)
	Equal operator for the EOS_Config_LocallyIsothermalDisc_ExtendedFarris2014 struct.

Detailed Description

Author

David Fang (david.nosp@m..fan.nosp@m.g@ikm.nosp@m.ail..nosp@m.com)

Timothée David–Cléris (tim.s.nosp@m.hamr.nosp@m.ock@p.nosp@m.roto.nosp@m.n.me)

Yona Lapeyre (yona..nosp@m.lape.nosp@m.yre@e.nosp@m.ns-l.nosp@m.yon.f.nosp@m.r)

Definition in file eos_config.hpp.

Function Documentation

operator==() [1/6]

template<class Tscal >

bool shamphys::operator== ( const EOS_Config_Adiabatic< Tscal > &  lhs, const EOS_Config_Adiabatic< Tscal > &  rhs  )

inline

Equal operator for the EOS_Config_Adiabatic struct.

Template Parameters

Tscal

Scalar type

Parameters

lhs	First EOS_Config_Adiabatic struct to compare
rhs	Second EOS_Config_Adiabatic struct to compare

This function checks if two EOS_Config_Adiabatic structs are equal by comparing their gamma values.

Returns

true if the two structs have the same gamma value, false otherwise

Definition at line 74 of file eos_config.hpp.

Here is the call graph for this function:

operator==() [2/6]

template<class Tscal >

bool shamphys::operator== ( const EOS_Config_Fermi< Tscal > &  lhs, const EOS_Config_Fermi< Tscal > &  rhs  )

inline

Equal operator for the EOS_Config_Fermi struct.

Template Parameters

Tscal

Scalar type

Parameters

lhs	First EOS_Config_Fermi struct to compare
rhs	Second EOS_Config_Fermi struct to compare

This function checks if two EOS_Config_Fermi structs are equal by comparing their mu_e values.

Returns

true if the two structs have the same mu_e values, false otherwise

Definition at line 145 of file eos_config.hpp.

Here is the call graph for this function:

operator==() [3/6]

template<class Tscal >

bool shamphys::operator== ( const EOS_Config_LocallyIsothermal_LP07< Tscal > &  lhs, const EOS_Config_LocallyIsothermal_LP07< Tscal > &  rhs  )

inline

Equal operator for the EOS_Config_LocallyIsothermal_LP07 struct.

Template Parameters

Tscal

Scalar type

Parameters

lhs	First EOS_Config_LocallyIsothermal_LP07 struct to compare
rhs	Second EOS_Config_LocallyIsothermal_LP07 struct to compare

This function checks if two EOS_Config_LocallyIsothermal_LP07 structs are equal by comparing their cs0, q, and r0 values.

Returns

true if the two structs have the same cs0, q, and r0 values, false otherwise

Definition at line 183 of file eos_config.hpp.

Here is the call graph for this function:

operator==() [4/6]

template<class Tscal >

bool shamphys::operator== ( const EOS_Config_LocallyIsothermalDisc_ExtendedFarris2014< Tscal > &  lhs, const EOS_Config_LocallyIsothermalDisc_ExtendedFarris2014< Tscal > &  rhs  )

inline

Equal operator for the EOS_Config_LocallyIsothermalDisc_ExtendedFarris2014 struct.

Template Parameters

Tscal

Scalar type

Parameters

lhs	First EOS_Config_LocallyIsothermalDisc_ExtendedFarris2014 struct to compare
rhs	Second EOS_Config_LocallyIsothermalDisc_ExtendedFarris2014 struct to compare

This function checks if two EOS_Config_LocallyIsothermalDisc_ExtendedFarris2014 structs are equal by comparing their cs0, q, r0, and n_sinks values.

Returns

true if the two structs have the same cs0, q, r0, and n_sinks values, false otherwise

Definition at line 287 of file eos_config.hpp.

Here is the call graph for this function:

operator==() [5/6]

template<class Tscal >

bool shamphys::operator== ( const EOS_Config_LocallyIsothermalDisc_Farris2014< Tscal > &  lhs, const EOS_Config_LocallyIsothermalDisc_Farris2014< Tscal > &  rhs  )

inline

Equal operator for the EOS_Config_LocallyIsothermalDisc_Farris2014 struct.

Template Parameters

Tscal

Scalar type

Parameters

lhs	First EOS_Config_LocallyIsothermalDisc_Farris2014 struct to compare
rhs	Second EOS_Config_LocallyIsothermalDisc_Farris2014 struct to compare

This function checks if two EOS_Config_LocallyIsothermalDisc_Farris2014 structs are equal by comparing their cs0, q, and r0 values.

Returns

true if the two structs have the same cs0, q, and r0 values, false otherwise

Definition at line 218 of file eos_config.hpp.

Here is the call graph for this function:

operator==() [6/6]

template<class Tscal >

bool shamphys::operator== ( const EOS_Config_Polytropic< Tscal > &  lhs, const EOS_Config_Polytropic< Tscal > &  rhs  )

inline

Equal operator for the EOS_Config_Polytropic struct.

Template Parameters

Tscal

Scalar type

Parameters

lhs	First EOS_Config_Polytropic struct to compare
rhs	Second EOS_Config_Polytropic struct to compare

This function checks if two EOS_Config_Polytropic structs are equal by comparing their K and gamma values.

Returns

true if the two structs have the same K and gamma values, false otherwise

Definition at line 110 of file eos_config.hpp.

Here is the call graph for this function: