forked from NOAA-EMC/fv3atm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
merge of master into dev/emc (NOAA-EMC#128)
* Removing use of mpp_io_mod and fms_io_mod from the dycore code. Replacing the necessary functions with fms2_io_mod functions * Adding a call to set_filename_appendix so that nest is added to filename when needed and removing unneccessary code in fv_io_mod * FV3 Documentation - formatted PDF and source files for FV3 documentation. * Documentation and defaults changes - Updated defaults for hord options to use 8 and 10, and removal of mention of hord = 9 (experimental, unsupported) scheme. * Initialize {sw,se,nw,ne}_corner to .false in model/fv_arrays.F90 (cherry picked from commit bf0630f) * merge of latest dev work from GFDL Weather and Climate Dynamics Division (NOAA-EMC#114) * read ak/bk from user specified files (NOAA-EMC#115) * add input.nml parameter fv_eta_file for user specified ak/bk; change ks calculation when npz_type=input; use newunit to replace fixed file unit for npz_type=input (cherry picked from commit 3a0d35a) * FV3 Example Notebooks and cleanup of docs directory (NOAA-EMC#117) * removed module use of INPUT_STR_LENGTH in fv_control.F90 (NOAA-EMC#122) * add check on eta levels to ensure their monotonicity * update Jili Dong's ak/bk external input to - use the FMS ascii_read (single read/broadcast) - error check input to ensure the proper number of levels present * added a format description for the external eta file and ensured a correct the file length check for FMS 2021.03 and greater * merge of minor updates from GFDL Weather and Climate Dynamics Division (20210804) (NOAA-EMC#127) Co-authored-by: Lauren Chilutti <Lauren.Chilutti@noaa.gov> Co-authored-by: laurenchilutti <60401591+laurenchilutti@users.noreply.github.com> Co-authored-by: lharris4 <53020884+lharris4@users.noreply.github.com> Co-authored-by: Dusan Jovic <dusan.jovic@noaa.gov> Co-authored-by: Jili Dong <jili.dong@noaa.gov>
- Loading branch information
1 parent
bdb078a
commit 86177e1
Showing
74 changed files
with
11,861 additions
and
7,529 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a bug report to help us improve | ||
title: '' | ||
labels: Bug | ||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**System Environment** | ||
Describe the system environment, include: | ||
- OS: [e.g. RHEL 7.2] | ||
- Compiler(s): Type and version [e.g. Intel 19.1] | ||
- MPI type, and version (e.g. MPICH, Cray MPI, openMPI) | ||
- netCDF Version: For both C and Fortran | ||
- Configure options: Any additional flags, or macros passed to configure | ||
|
||
**Additional context** | ||
Add any other context about the problem. If applicable, include where any files | ||
that help describe, or reproduce the problem exist. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: 'enhancement' | ||
assignees: '' | ||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
name: Support request | ||
about: Request for help | ||
title: '' | ||
labels: 'question' | ||
assignees: '' | ||
--- | ||
|
||
**Is your question related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. | ||
|
||
**Describe what you have tried** | ||
A clear and concise description of what steps you have taken. Include command | ||
lines, and any messages from the command. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
# Coding Style | ||
|
||
## General | ||
|
||
* Trim all trailing whitespace from every line (some editors can do this | ||
automatically). | ||
* No tab characters. | ||
* A copy of the FV3 Gnu Lesser General Public License Header | ||
must be included at the top of each file. | ||
* Supply an author block for each file with a description of the file and the author(s) | ||
name or GitHub ID. | ||
* Documentation may be written so that it can be parsed by [Doxygen](http://www.doxygen.nl/). | ||
* All variables should be defined, and include units. Unit-less variables should be marked `unitless` | ||
* Provide detailed descriptions of modules, interfaces, functions, and subroutines | ||
* Define all function/subroutine arguments, and function results (see below) | ||
* Follow coding style of the current file, as much as possible. | ||
|
||
## Fortran | ||
|
||
### General | ||
|
||
* Use Fortran 95 standard or newer | ||
* Two space indentation | ||
* Never use implicit variables (i.e., always specify `IMPLICIT NONE`) | ||
* Lines must be <= 120 characters long (including comments) | ||
* logical, compound logical, and relational if statements may be one line, | ||
using “&” for line continuation if necessary: | ||
```Fortran | ||
if(file_exists(fileName)) call open_file(fileObj,fileName, is_restart=.false) | ||
``` | ||
* Avoid the use of `GOTO` statements | ||
* Avoid the use of Fortran reserved words as variables (e.g. `DATA`, `NAME`) | ||
* `COMMON` blocks should never be used | ||
|
||
### Derived types | ||
|
||
* Type names must be in CapitalWord format. | ||
* Description on the line before the type definition. | ||
* Inline doxygen descriptions for all member variables. | ||
|
||
## Functions | ||
* Functions should include a result variable on its own line, that does not have | ||
a specific intent. | ||
* Inline descriptions for all arguments, except the result variable. | ||
* Description on the line(s) before the function definition. Specify what the function is returning (with the `@return` doxygen keyword if using doxygen). | ||
|
||
## Blocks | ||
* terminate `do` loops with `enddo` | ||
* terminate block `if`, `then` statements with `endif` | ||
|
||
## OpenMP | ||
|
||
* All openMP directives should specify default(none), and then explicitly list | ||
all shared and private variables. | ||
* All critical sections must have a unique name. | ||
|
||
## Fortran Example | ||
|
||
```Fortran | ||
!*********************************************************************** | ||
!* GNU Lesser General Public License | ||
!* | ||
!* This file is part of the FV3 dynamical core. | ||
!* | ||
!* The FV3 dynamical core is free software: you can redistribute it | ||
!* and/or modify it under the terms of the | ||
!* GNU Lesser General Public License as published by the | ||
!* Free Software Foundation, either version 3 of the License, or | ||
!* (at your option) any later version. | ||
!* | ||
!* The FV3 dynamical core is distributed in the hope that it will be | ||
!* useful, but WITHOUT ANYWARRANTY; without even the implied warranty | ||
!* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | ||
!* See the GNU General Public License for more details. | ||
!* | ||
!* You should have received a copy of the GNU Lesser General Public | ||
!* License along with the FV3 dynamical core. | ||
!* If not, see <http://www.gnu.org/licenses/>. | ||
!*********************************************************************** | ||
!> @file | ||
!! @brief Example code | ||
!! @author <developer> | ||
!! @email <email> | ||
module example_mod | ||
use util_mod, only: util_func1 | ||
implicit none | ||
private | ||
public :: sub1 | ||
public :: func1 | ||
!> @brief Doxygen description of type. | ||
type,public :: CustomType | ||
integer(kind=<KIND>) :: a_var !< Inline doxygen description. | ||
real(kind=<KIND>),dimension(:),allocatable :: b_arr !< long description | ||
!! continued on | ||
!! multiple lines. | ||
endtype CustomType | ||
contains | ||
!> @brief Doxygen description. | ||
subroutine sub1(arg1, & | ||
& arg2, & | ||
& arg3) | ||
real(kind=<KIND>),intent(in) :: arg1 !< Inline doxygen description. | ||
integer(kind=<KIND>),intent(inout) :: arg2 !< Inline doxygen description. | ||
character(len=*),intent(inout) :: arg3 !< Long inline doxygen | ||
!! description. | ||
end subroutine sub1 | ||
!> @brief Doxygen description | ||
!! @return Function return value. | ||
function func1(arg1, & | ||
& arg2) & | ||
& result(res) | ||
integer(kind=<KIND>),intent(in) :: arg1 !< Inline doxygen description | ||
integer(kind=<KIND>),intent(in) :: arg2 !< Inline doxygen description | ||
integer(kind=<KIND>) :: res | ||
end function func1 | ||
end module example_mod | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.