calc_BE Module Reference

This module contains the subroutines and functions that are called to compute the binding energy for a set of stellar parameters. This module should be USEd by the calling program. More...

List of all members.

Public Member Functions
subroutine, public	read_BE_input (path)
	This subroutine reads the input files for all available metallicities. Call this routine once when starting your program, before calling the function calc_logBE() or calc_logBE_recom().
subroutine, public	read_BE_input_Z (path, iz)
	This subroutine reads the input file for the iz-th metallicity in the database. It is called by read_BE_input(), and in principle there is no need for the user to call it directly.
real(double) function, public	calc_logBE (logZ, Mzams, M, logR, GB, ignore_massloss)
	This function computes log[BE/erg] as a function of log[Z], Mzams, M, log[R/Ro] and GB.
real(double) function, public	calc_logBE_recom (logZ, M, logR)
	This function computes the recombination-energy term log[BE_recom/erg] as a function of log[Z], M, and log[R/Ro].

---

Detailed Description

This module contains the subroutines and functions that are called to compute the binding energy for a set of stellar parameters. This module should be USEd by the calling program.

---

Member Function/Subroutine Documentation

subroutine, public calc_BE::read_BE_input

(

character, dimension(*), intent(in)

path

)

This subroutine reads the input files for all available metallicities. Call this routine once when starting your program, before calling the function calc_logBE() or calc_logBE_recom().

Parameters:

path	The path (relative or absolute) where the input data files can be found.

Return values:

None	The data that are read in are distributed via the module BE_data.

subroutine, public calc_BE::read_BE_input_Z	(	character, dimension(*), intent(in)	path,
		integer, intent(in)	iz
	)

This subroutine reads the input file for the iz-th metallicity in the database. It is called by read_BE_input(), and in principle there is no need for the user to call it directly.

Parameters:

path	The path (relative or absolute) where the input data files can be found;
iz	Number of the desired metallicity in the database.

Return values:

None	The data that are read in are distributed via the module BE_data.

real(double) function, public calc_BE::calc_logBE	(	real(double), intent(in)	logZ,
		real(double), intent(in)	Mzams,
		real(double), intent(in)	M,
		real(double), intent(in)	logR,
		integer, intent(in)	GB,
		logical, intent(in), optional	ignore_massloss
	)

This function computes log[BE/erg] as a function of log[Z], Mzams, M, log[R/Ro] and GB.

Parameters:

logZ	10-base log of metallicity (solar = log[0.02]);
Mzams	stellar ZAMS mass (in solar masses);
M	current stellar mass (in solar masses);
logR	10-base log of stellar radius, expressed in solar radii (log[R/Ro]);
GB	giant branch: 1: RGB, 2: AGB (CO core exists).
ignore_massloss	if true, ignore the factor Lambda that corrects for mass loss (logical, optional; default: false)

Return values:

calc_logBE

The 10-base log of the absolute value of the envelope binding energy expressed in erg.

real(double) function, public calc_BE::calc_logBE_recom	(	real(double), intent(in)	logZ,
		real(double), intent(in)	M,
		real(double), intent(in)	logR
	)

This function computes the recombination-energy term log[BE_recom/erg] as a function of log[Z], M, and log[R/Ro].

Parameters:

logZ	10-base log of metallicity (solar = log[0.02]);
M	current stellar mass (in solar masses);
logR	10-base log of stellar radius, expressed in solar radii (log[R/Ro]);

Return values:

calc_logBE

The 10-base log of the absolute value of the envelope binding energy expressed in erg.

---

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

• src/binding_energy.f90