Skip to content

Documentation improvements for 3.0.0: Auto-reduction solver and State_Het#51

Merged
yantosca merged 2 commits intoKineticPreProcessor:devfrom
jimmielin:misc_cleanup
Jun 27, 2022
Merged

Documentation improvements for 3.0.0: Auto-reduction solver and State_Het#51
yantosca merged 2 commits intoKineticPreProcessor:devfrom
jimmielin:misc_cleanup

Conversation

@jimmielin
Copy link
Copy Markdown
Member

In reference to previous conversation in #50

I've added two commits here to

  1. describe rosenbrock_autoreduce in the Numerical Methods section, and
  2. add a blurb about using derived type objects to store state information for KPP use, as used by GEOS-Chem in State_Het. Also added the use of commonIncludeVars.H to avoid cluttering up .kpp code. Please feel free to edit 😃

@jimmielin jimmielin requested review from RolfSander and yantosca June 27, 2022 15:55
Copy link
Copy Markdown
Contributor

@RolfSander RolfSander left a comment

Choose a reason for hiding this comment

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

The autoreduce description looks good.

The additional text for F90_GLOBAL is very interesting, but it is also
very GEOS-Chem specific. I think the main points here are that F90_GLOBAL
can also be used to:

  • define derived-type objects

and

  • #include additional input files

Maybe the description in the KPP manual could focus on these general
points and refer to the GEOS-Chem manual for specifics about State_Het
and commonIncludeVars.H?

Copy link
Copy Markdown
Contributor

@yantosca yantosca left a comment

Choose a reason for hiding this comment

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

I also think the autoreduce section looks good.

As @RolfSander said, we can remove the GEOS-Chem-specific reference but say that you can add derived a derived-type definition in F90_Global. I can work on that.

@yantosca yantosca merged commit 95fddb3 into KineticPreProcessor:dev Jun 27, 2022
@yantosca
Copy link
Copy Markdown
Contributor

I updated the F90_RATES and F90_RCONST sections.

@RolfSander
Copy link
Copy Markdown
Contributor

Thanks, @yantosca!

I added that USE must come before any variable definitions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants