Skip to content

Fix to documentation as requested in #1442 #1457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ilyamandel merged 3 commits into from
Mar 9, 2026
+16 −8
Merged

Fix to documentation as requested in #1442 #1457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ac157b
Fix to documentation as requested in #1442
Mar 6, 2026
4c5fed1
Good to go, along with update to Matlab comparison script (not for re…
Mar 6, 2026
38d608c
labeled -> labelled
Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions compas_matlab_utils/ComparisonPlots.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,12 @@ function ComparisonPlots(filename1, name1, filename2, name2)

%Plot LMXBs/IMXBs
figure(fignumber); clf(fignumber);
[LMXBcount, NSLMXBcount]=LMXBplot(filename1, name1, fignumber, 'r', 40);
fprintf('\nLMXBs:\t\t#LMXB\t\t#NS LMXB\n');
fprintf('%s:\t%d\t\t%d\n', name1, LMXBcount, NSLMXBcount);
[LMXBcount, NSLMXBcount, meanduration]=LMXBplot(filename1, name1, fignumber, 'r', 40);
fprintf('\nLMXBs:\t\t#LMXB\t\t#NS LMXB\tLMXB mean duration (Myr)\n');
fprintf('%s:\t%d\t\t%d\t\t%f\n', name1, LMXBcount, NSLMXBcount, meanduration);
if(nargin==4),
[LMXBcount, NSLMXBcount]=LMXBplot(filename2, name2, fignumber, 'b', 20);
fprintf('%s:\t%d\t\t%d\n', name2, LMXBcount, NSLMXBcount);
[LMXBcount, NSLMXBcount, meanduration]=LMXBplot(filename2, name2, fignumber, 'b', 20);
fprintf('%s:\t%d\t\t%d\t\t%f\n', name2, LMXBcount, NSLMXBcount, meanduration);
end;
figure(fignumber), hold off; set(gca,'FontSize', 20); legend; title('LMXB on first MT onto CO');
xlabel('Compact object mass (M$_\odot$)', 'Interpreter', 'latex'), ylabel('Companion mass (M$_\odot$)', 'Interpreter', 'latex');
Expand Down Expand Up @@ -300,7 +300,7 @@ function BeXRBplot(file, name, fignumberBeXRB, colour, point)
%Find all LMXBs/IMXBs at the time of the first mass transfer episode onto the
%compact object. They consist of an NS or a BH and a companion with a mass
%below 5 Msun.
function [LMXBcount, NSLMXBcount] = LMXBplot(file, name, fignumberLMXB, colour, point)
function [LMXBcount, NSLMXBcount, meanduration] = LMXBplot(file, name, fignumberLMXB, colour, point)
seedRLOF=h5read(file,'/BSE_RLOF/SEED');
timeRLOF=h5read(file,'/BSE_RLOF/Time>MT');
M1RLOF=h5read(file,'/BSE_RLOF/Mass(1)<MT');
Expand All @@ -312,13 +312,19 @@ function BeXRBplot(file, name, fignumberBeXRB, colour, point)
timeCE=h5read(file,'/BSE_Common_Envelopes/Time');
relevantbinary=(star1RLOF>=13 & star1RLOF<=14 & star2RLOF==1 & M2RLOF<=5 & ~RLOFisCE) ...
| (star2RLOF>=13 & star2RLOF<=14 & star1RLOF==1 & M1RLOF<=5 & ~RLOFisCE);
%relevantbinary=(star1RLOF>=13 & star1RLOF<=14 & star2RLOF==1 & M2RLOF<=1.5 & ~RLOFisCE) ...
% | (star2RLOF>=13 & star2RLOF<=14 & star1RLOF==1 & M1RLOF<=1.5 & ~RLOFisCE); %if we want to consider only true LMXBs
relevantseedRLOF=cast(seedRLOF, 'int64'); relevantseedRLOF(~relevantbinary)=-1;
uniqueseeds=unique(seedRLOF(relevantbinary));
[blah,indexlist]=ismember(cast(uniqueseeds,'int64'), relevantseedRLOF);
M1relevant=M1RLOF(indexlist); M2relevant=M2RLOF(indexlist);
MCO=M1relevant; MCO(star2RLOF(indexlist)>=13)=M2relevant(star2RLOF(indexlist)>=13);
Mcomp=M1relevant; Mcomp(star2RLOF(indexlist)==1)=M2relevant(star2RLOF(indexlist)==1);
LMXBcount=length(MCO); NSLMXBcount=sum(MCO<2); %number of LMXBs, NS LXMBs
[blah,indexlistlast]=ismember(cast(uniqueseeds,'int64'), flip(relevantseedRLOF));
indexlistlast=length(seedRLOF)-indexlistlast+1;
duration=timeRLOF(indexlistlast)-timeRLOF(indexlist);
meanduration=mean(duration);
[isCE,CEIndex]=ismember(uniqueseeds,seedCE); %doesn't check if CE happened before or after
precededbyCE=false(size(indexlist));
for(i=1:length(indexlist)), if(isCE(i)), precededbyCE(i)=(timeCE(CEIndex(i)) < timeRLOF(indexlist(i))); end; end;
Expand Down
6 changes: 4 additions & 2 deletions online-docs/pages/User guide/Program options/program-options-list-defaults.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ Slope for the Kruckow lambda (see Kruckow et al. 2016 as implemented by Vigna-Go
Default = −0.833333

**--convective-envelope-mass-threshold** |br|
Mass threshold of envelope which should be convective, above which the envelopes of giants are labeled convective. |br|
Mass threshold of envelope which should be convective, above which the envelopes of giants are labelled convective. |br|
Only used for --envelope-state-prescription = CONVECTIVE_MASS_FRACTION, ignored otherwise. |br|
Default = 0.1

Expand Down Expand Up @@ -402,10 +402,12 @@ Default = TRUE

**--envelope-state-prescription** |br|
Prescription for determining whether the envelope of the star is convective or radiative. |br|
Options: { LEGACY, HURLEY, FIXED_TEMPERATURE } |br|
Options: { LEGACY, HURLEY, FIXED_TEMPERATURE, CONVECTIVE_MASS_FRACTION } |br|
``LEGACY`` refers to the model used in Stevenson et al., 2017 |br|
``HURLEY`` refers to the model of Hurley, Pols, Tout, 2002 |br|
``FIXED_TEMPERATURE`` assumes that a deep convective envelope developes only when the temperature drops below ``CONVECTIVE_BOUNDARY_TEMPERATURE`` (Klencki et al., 2020) |br|
``CONVECTIVE_MASS_FRACTION`` means that whether the envelope is labelled convective is determined by the fraction of the envelope's mass which is convective;
that threshold can be changed from its default value with the additional option ``--convective-envelope-mass-threshold`` |br|
Default = LEGACY

**--errors-to-file** |br|
Expand Down