Skip to content

Commit

Permalink
Merge in a few small doc changes.
Browse files Browse the repository at this point in the history
Merge branch 'sph_vec_doc_tweaks' into develop
  • Loading branch information
oehmke committed Oct 27, 2023
2 parents b148b07 + 4ed7024 commit 59c110d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
8 changes: 6 additions & 2 deletions src/Infrastructure/Field/src/ESMF_FieldRegrid.F90
Original file line number Diff line number Diff line change
Expand Up @@ -548,9 +548,13 @@ subroutine ESMF_FieldRegridStoreNX(srcField, dstField, keywordEnforcer, &
! \item [{[vectorRegrid]}]
! If true, treat a single ungridded dimension in the source and destination Fields
! as the components of a vector. If true and there is more than one ungridded dimension in either
! the source or destination, then an error will be returned. Currently this functionality only
! the source or destination, then an error will be returned. Currently, only undistributed (vector) dimensions of
! size 2 are supported. In the vector dimension, the first entry is interpreted as the east component and the
! second as the north component.
! In addition, this functionality presently only
! works when both the source and destination Fields are build on a geometry (e.g. an ESMF Grid) with
! a spherical coordinate system (e.g. ESMF\_COORDSYS\_SPH\_DEG). See section~\ref{sec::vectorRegrid} for further
! a spherical coordinate system (e.g. ESMF\_COORDSYS\_SPH\_DEG). We expect these restrictions to be loosened over
! time as new requirements come in from users. See section~\ref{sec::vectorRegrid} for further
! information on this functionality. If not specified, this argument defaults to false.
! \item [{[extrapMethod]}]
! The type of extrapolation. Please see Section~\ref{opt:extrapmethod}
Expand Down
9 changes: 4 additions & 5 deletions src/doc/ESMF_infradataoverview.tex
Original file line number Diff line number Diff line change
Expand Up @@ -782,16 +782,15 @@ \subsubsection{Vector regridding}\label{sec::vectorRegrid}
However, the weight matrix will be in the format that allows it to contain tensor dimension indices (i.e. the leading
dimension of the {\tt factorIndexList} will be of size 4).

In this initial version the meaning of the different components in the vector is fixed. They will be interpreted as:
In this initial version, the meaning of the different entries in the vector dimension are fixed. They will be interpreted as:
\vspace{-1em}
\begin{description}
\itemsep0em
\item[1st component] the east value
\item[2nd component] the north value
\item[1st entry] the east component of the vector
\item[2nd entry] the north component of the vector
\end{description}

Note that because the different components are mixed, using vector regridding with a conservative regrid method will not necessarily produce vectors whose components
are conservative.
Note that because the different components are mixed, using vector regridding with a conservative regrid method will not necessarily produce vectors whose components are conservative.


\subsubsection{Troubleshooting guide}
Expand Down

0 comments on commit 59c110d

Please sign in to comment.