Skip to content

Commit

Permalink
Update docstring of is_first_step function
Browse files Browse the repository at this point in the history
  • Loading branch information
@slevis-lmwg
slevis-lmwg committed Nov 12, 2024
1 parent 0f54bc2 commit a4b9dcf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/utils/clm_time_manager.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1734,7 +1734,7 @@ end function is_end_curr_year
logical function is_first_step()

!---------------------------------------------------------------------------------
! Return true on first step of initial run only.
! Return true on first step of any run.

! Local variables
character(len=*), parameter :: sub = 'clm::is_first_step'
Expand Down

3 comments on commit a4b9dcf

@olyson
Copy link
Contributor

@olyson olyson commented on a4b9dcf Nov 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand this change, but we can discuss tomorrow. The function will only be true when nstep=1, in other words the first step of an initial run, not a restart or branch run. There is another function that is used called is_first_step_of_this_run_segment, which is true if it is the first step of any run segment (initial, restart or branch run).

@slevis-lmwg
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, I should change the comment to say "startup and hybrid"

@olyson
Copy link
Contributor

@olyson olyson commented on a4b9dcf Nov 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that is what was meant by "initial", but I like the clearer "startup and hybrid".

Please sign in to comment.