Update the use of Collective on in the manual pages to reflect the new style

Commit-type: style-fix, documentation
Thanks-to: Patrick Sanan <patrick.sanan@gmail.com>

Merged in psanan/man-pages-remove-keywords (pull request #1717)

Man pages: Remove .keywords fields

Approved-by: BarryFSmith <bsmith@mcs.anl.gov>

Man pages: remove .keywords: fields

This field is recognized by doctext from Sowing (http://wgropp.cs.illinois.edu/projects/software/sowing/doctext/node20.htm#Node20),
but it doesn't seem to be unif

Man pages: remove .keywords: fields

This field is recognized by doctext from Sowing (http://wgropp.cs.illinois.edu/projects/software/sowing/doctext/node20.htm#Node20),
but it doesn't seem to be uniformly used or maintained.

Thus, remove all .keywords: fields, and a following blank line, if present.

This is accomplished with GNU sed (gsed on OS X), with the following commands.
*Warning* that this type of command can corrupt a .git directory,
so be cautious in reusing or modifying these commands. They first look
for and delete matching lines with a following line consisting of only whitespace,
and then delete any remaining matching lines.

find src/ -type f -exec gsed -i '/keywords:/ {N; /\n\s*$/d}' {} +
find src/ -type f -exec gsed -i '/keywords:/d' {} +
find include/ -type f -exec gsed -i '/keywords:/ {N; /\n\s*$/d}' {} +
find include/ -type f -exec gsed -i '/keywords:/d' {} +

Hints on the sed command obtained from: https://unix.stackexchange.com/questions/100754/how-to-delete-a-specific-line-and-the-following-blank-line-using-gnu-sed

show more ...

Merge branch 'master' into jpusztay/feature-swarm-symplectic-example

Merged petsc/petsc into master

Merge branch 'master' into knepley/feature-snes-patch

Merged petsc/petsc into master

Merged petsc/petsc into master

Merge branch 'master' into knepley/fix-plex-partition-parallel

* master: (414 commits)
very small updates to users manual
syntax is define(XXX) in examples tests not defined(XXX)
Increase patc

Merge branch 'master' into knepley/fix-plex-partition-parallel

* master: (414 commits)
very small updates to users manual
syntax is define(XXX) in examples tests not defined(XXX)
Increase patchlevel to 3.10.3
petsc4py: updat to latest maint snapshot with SNESTEST updates
Fix link for CUDA example in PETSc from GPUs.html page Minor fixes to installation instructions
Mat: Fixed types in Pardiso interface
Converted example comment to latex
This example crashes (for unknown reasons, probably related to the handling of extended derived types passed as arguments) with the PGI Fortran compiler
Remove outdated requires: from top of several examples
remove outdated test requires: command from top of source file
Fix the documentation for -ksp_gmres_cgs_refinement_type
Commit f20c2d659b168217cb455989f28afe052d71a64c broke lex.py so the users manual was no longer being built. There reverted the changes to lex.py
Plex: Add PetscPartitioner to fort list Suggested-by: Jiaoyan Li <Jiaoyan.Li@inl.gov>
Doc: Fix spelling Suggested-by: Manuel Colera Rico <m.colera@upm.es>
Mat ex88: check in double or quad precision only
Fix error with PetscComplex when PETSc is compiled with C and used in C++
configure: fix typo endwith -> endswith
Sys ex23: Migrated to ts_max_time in yaml file as well.
AO ex5: Fixed missing CHKERRQ();
Mat test ex88: add tests for MatMultAdd and MatMultTranposeAdd
...

Conflicts:
src/dm/impls/plex/examples/tests/ex12.c

show more ...

Merge branch 'barry/fix-aomemscalable-negative-indices-maint' into maint [PR #1270]

* barry/fix-aomemscalable-negative-indices-maint:
Fix AOMEMORYSCALABLE for negative indices

Merge branch 'barry/fix-aomemscalable-negative-indices-maint' [PR #1270]

* barry/fix-aomemscalable-negative-indices-maint:
Fix AOMEMORYSCALABLE for negative indices

Fix AOMEMORYSCALABLE for negative indices

Commit-type: bug-fix, example
Reported-by: Huy Vo <Huy.Vo@colostate.edu>

Merge branch 'master' into knepley/feature-plex-functionals

* master: (984 commits)
netcdf: set zlib as optional dependency corretly [wrt --enable-netcdf-4] - otherwise netcdf configure errors out

Merge branch 'master' into knepley/feature-plex-functionals

* master: (984 commits)
netcdf: set zlib as optional dependency corretly [wrt --enable-netcdf-4] - otherwise netcdf configure errors out
fix gcov obj path
-options_table was changed to options_view in 2014 but documentation was not updated to reflect it
configure: fix F2003 test
Dev manual: remove duplicate entry
Plex test ex5: Removed "future" test, as it resulted in issues in the nightly tests.
Some minor typos in TS
Add ADIOS2.py which I forgot to git add in the past
Plex ex5: Disable test
Doc: Added note for interface change
KSPLSQRMonitorDefault fixed for quad precision
Tao: Added alternative output for chwirut2 test.
TS ex45,ex46: Removed overly refined tests for faster nightly tests.
KSP ex72: Fixed needlessly long-running PCTFS tests.
SNES ex56: Reduced test size to speed up nightly test suite.
KSPSolve_LSQR: don't compute unused norm of rhs
SNES ex13: Reduced problem sizes for nightly tests.
PetscOptionsDeprecated(): fix for NULL prefix
PetscOptionsDeprecated(): add option to print additional info
SNES ex12: Reduced sizes for BDDC tests.
...

show more ...

Merge branch 'master' into knepley/feature-plex-elasticity-test

* master: (1553 commits)
-options_table was changed to options_view in 2014 but documentation was not updated to reflect it
config

Merge branch 'master' into knepley/feature-plex-elasticity-test

* master: (1553 commits)
-options_table was changed to options_view in 2014 but documentation was not updated to reflect it
configure: fix F2003 test
Plex test ex5: Removed "future" test, as it resulted in issues in the nightly tests.
Some minor typos in TS
Add ADIOS2.py which I forgot to git add in the past
Plex ex5: Disable test
Doc: Added note for interface change
KSPLSQRMonitorDefault fixed for quad precision
Tao: Added alternative output for chwirut2 test.
TS ex45,ex46: Removed overly refined tests for faster nightly tests.
KSP ex72: Fixed needlessly long-running PCTFS tests.
SNES ex56: Reduced test size to speed up nightly test suite.
KSPSolve_LSQR: don't compute unused norm of rhs
SNES ex13: Reduced problem sizes for nightly tests.
PetscOptionsDeprecated(): fix for NULL prefix
PetscOptionsDeprecated(): add option to print additional info
SNES ex12: Reduced sizes for BDDC tests.
PetscFileRetrieve(): Suppress output to STDERR when downloading a file.
MatMatMult: Fixed unused variable pN.
DMDestroy: Guard call to dm->ops->destroy * Similar guards are in place in many other methods (IS,Vec,Mat) and permit the DM to be destroyed even if DMSetType() was never called.
...

show more ...

Merge branch 'master' into knepley/feature-plex-parallel-submesh

* master: (2931 commits)
remove N in docs for SNESQN
replaced test tolerance with PETSC_SQRT_MACHINE_EPSILON
fortran: PetscComp

Merge branch 'master' into knepley/feature-plex-parallel-submesh

* master: (2931 commits)
remove N in docs for SNESQN
replaced test tolerance with PETSC_SQRT_MACHINE_EPSILON
fortran: PetscComplex type is missing from fortran
initialize variables so that static analyzer doesn't mistakenly think they are used uninitialized.
Move access of prefix until it is actually used
Remove DMDASplitComm2d(), used in one example that was not tested
Functions that do not return PetscErrorCode should not use PetscFunctionBegin/End paradgm
remove unneeded reassignment of same value
Missing CHKERRQ(); Mostly in Tao code
Remove clang static analyser warning about passing NULL variable to strncat()
missing newline in -ts_monitor_extreme
minor fixes for integer counters
Configure: Deal with '__func__' in C89 builds with newer Clang and GCC.
Jenkinsfile: Increased timeout for tests to 5 minutes.
3.9 changes: further clarify removal of -pc_factor_mat_solver_package
Options deprecations: add "PETSc" to inline warning
removing unused variable
MatShift support added to MATSUBMAT. Mimics MATSHELL functionality. Needed for matrix-free Hessians in TAO Newton-Line-Search methods.
Add -ts_monitor_extreme
Dev manual: add note on deprecating options database keys
...

Conflicts:
src/dm/impls/plex/examples/tests/ex4.c

show more ...

Merge branch 'master' into knepley/feature-pc-patch

* master: (562 commits)
fix clang-analyzer warning
Developers manual never use system randomizers in PETSc and example source code.
missing

Merge branch 'master' into knepley/feature-pc-patch

* master: (562 commits)
fix clang-analyzer warning
Developers manual never use system randomizers in PETSc and example source code.
missing CHKERRQ()
DT: Reverting the tgamma change broke MPFR - I guess we need a nightly build with it in
Add a test for ex21
Fix error in ex21
Add missing fortran interface that handles null objects
DMComposite: add missing guards
MatPreallocate: fix overpreallocation of local rows
style fixes
MatView_MPI_DA: do not print twice the class prefix
MatSetOperation: stash the original MatView_XXX in the viewnative function pointer
DMCreateInterpolation_DA gracefully error instead of catching FPE signals
MatIncreaseOverlap: preserve communicator of index sets
MatMPIAIJ: fix indentation and missing CHKERRQ
ISBuildTwoSided: remove tabs and fix style
Fix documentation
PetscViewerDraw: fix unininitialized warning from valgrind
MatConvert_SeqAIJ_SeqBAIJ: remove error for non square matrices and add MAT_REUSE_MATRIX case
Mat: MAT_INPLACE_MATRIX can be used for transposition with rectangular matrices
...

Conflicts:
src/dm/dt/interface/dtfe.c
src/dm/impls/plex/plex.c
src/dm/impls/plex/plexfem.c
src/snes/examples/tutorials/ex13.c
src/snes/examples/tutorials/ex62.c
src/snes/examples/tutorials/makefile
src/snes/examples/tutorials/output/ex62_18.out
src/snes/examples/tutorials/output/ex62_19.out
src/snes/examples/tutorials/output/ex62_20.out
src/snes/examples/tutorials/output/ex62_20_parmetis.out
src/snes/examples/tutorials/output/ex62_21.out
src/snes/examples/tutorials/output/ex62_22.out
src/snes/examples/tutorials/output/ex62_23.out
src/snes/examples/tutorials/output/ex62_24.out
src/snes/examples/tutorials/output/ex62_25.out
src/snes/examples/tutorials/output/ex62_26.out
src/snes/examples/tutorials/output/ex62_27.out
src/snes/examples/tutorials/output/ex62_28.out
src/snes/examples/tutorials/output/ex62_29.out
src/snes/examples/tutorials/output/ex62_2d_p3_1.out
src/snes/examples/tutorials/output/ex62_30.out
src/snes/examples/tutorials/output/ex62_31.out
src/snes/examples/tutorials/output/ex62_32.out
src/snes/examples/tutorials/output/ex62_33.out
src/snes/examples/tutorials/output/ex62_34.out
src/snes/examples/tutorials/output/ex62_35.out
src/snes/examples/tutorials/output/ex62_36.out
src/snes/examples/tutorials/output/ex62_pc_simple.out
src/snes/examples/tutorials/output/ex62_pc_simplec.out
src/snes/examples/tutorials/output/ex62_quad_q2p1_full.out
src/snes/examples/tutorials/output/ex62_quad_q2q1_full.out
src/snes/utils/dmplexsnes.c

show more ...

Merge branch 'master' into knepley/feature-error-logging

* master: (221 commits)
dashboard: count and list example compile failures like:
fix fix-pr879-jczhang-optimize-vecscatter-multi-copy
a

Merge branch 'master' into knepley/feature-error-logging

* master: (221 commits)
dashboard: count and list example compile failures like:
fix fix-pr879-jczhang-optimize-vecscatter-multi-copy
add manual page cross links for SNESLineSearchSetPostCheck() and related routines
fix help manual of MatCreateSubmatrices() Reported-by: Tim Steinhoff <kandanovian@gmail.com>
Add manual pages for PetscRealPart() and PetscImaginaryPart()
fix compile error with missing MPI_C_DOBULE_COMPLEX
fix typo Reported-by: Febrian Setianto <febrian.setianto@gmail.com>
plex tutorial ex5: updated test requirements
DMPlexLoad_HDF5_Xdmf_Internal: fix for complex PetscScalar.
DMPlexLoad_HDF5_Xdmf_Internal: fix for 64-bit PetscInt.
DMPlexBuildFromCellList_Internal: use DMPlexInvertCell_Internal (with PetscInt* arg)
petscviewer.h: removed notice which is no longer relevant
DMPlexCreateFromFile: document option
check only if PETSC_USE_DEBUG
DMPlexBuildFromCellList_Internal optionally inverts cells.
ex5: new test 4 with -compare without repartitioning
ex5: new test 3 using -compare
ex5: HDF5 write+read moved to separate function
ex5: option -format processed in ProcessOptions()
ex5: added missing hdf5 requirement
...

Conflicts:
include/petsclog.h

show more ...

Merge branch 'psanan/manpages-notes-newlines' [PR #932]

* psanan/manpages-notes-newlines:
A large number of man pages are improperly formatted because of the lack of a newline after "Notes:", "Fortr

Merge branch 'psanan/manpages-notes-newlines' [PR #932]

* psanan/manpages-notes-newlines:
A large number of man pages are improperly formatted because of the lack of a newline after "Notes:", "Fortran Notes:", or "Developer Notes:".
This batch adds those newlines, with 4 spaces of indentation afterwards.
The uniform indentation arguably makes the man pages a little less readable in the source itself,
but overall this hopefully has a large positive impact on the readability of the HTML pages.

show more ...

Man pages: add newlines after "Notes:"

This allows for proper formatting from sowing.

On OS X (using gsed, not the default BSD sed), from the PETSc root directory:

find src include -type f \(

Man pages: add newlines after "Notes:"

This allows for proper formatting from sowing.

On OS X (using gsed, not the default BSD sed), from the PETSc root directory:

find src include -type f \( -name "*.c" -or -name "*.h" -or -name "*.cxx" \) | xargs gsed -i 's/Notes\s*:\s*\(\w.*\)/Notes:\n \1/'

This adds a newline and 4 spaces whenever "Notes:" is followed by any "word" character, in any .c, .h, or .cxx file in src/ or include/

show more ...

Merge commit 'd47bf9aaf1e5266cc3f0ff499f934c85788965a9' into jed/fix-matcreatempibaij/maint

Obtain changed (v3.5) handling of MatMPIBAIJSetPreallocationCSR to match
documentation.

Merge branch 'master' into knepley/feature-plex-sphere-mesh

* master: (2633 commits)
Bib: Added ref
SNES ex56: Update test output
add a citation to petsc.bib
Plex: Initialize variables
ini

Merge branch 'master' into knepley/feature-plex-sphere-mesh

* master: (2633 commits)
Bib: Added ref
SNES ex56: Update test output
add a citation to petsc.bib
Plex: Initialize variables
initialize ap as complained by the nightly tests
Plex ex3: Update to new point function API
initialize some variables as complained by nightly tests
SNES ex12: Mix misnaming Nf --> Nc
update tests
add tests
add MatView_SeqXAIJ_ASCII_structonly(); enable A->structure_only in MatSetValuesBlocked_SeqBAIJ
typo
fill-in some references
Bib: Fixed ref
Plex: Added PLY to file support
Plex: Adding PLY support
PetscDS: Turn off Fortran bindings for Constants
Plex tests: Updated to new point function API
SNES ex56: Moved tests to new format
DM: Allow field projection functions to take an array of scalars - This will allow us to pass in user data to kernels without void *, more efficiency than aux fields
...

Conflicts:
config/builder.py
include/petscdmplex.h
src/dm/impls/plex/examples/tests/ex1.c
src/dm/impls/plex/plexcreate.c
src/dm/impls/plex/plexgmsh.c
src/snes/examples/tutorials/ex63.c

show more ...

Merge branch 'master' into knepley/feature-plex-pragmatic-parallel

* master: (1379 commits)
Minor fixes for tchem examples due to changes in PETSc infrastructure
update webpage about API changes

Merge branch 'master' into knepley/feature-plex-pragmatic-parallel

* master: (1379 commits)
Minor fixes for tchem examples due to changes in PETSc infrastructure
update webpage about API changes
add help menu for MatCreateSubMatricesMPI()
rename struct Mat_SubMat -> Mat_SubSppt
add a little information to the manual about using tchem
rename MatCreateSubMatrixComposite -> MatCreateSubMatrixVirtual; Mat_SubMatrix -> Mat_SubVirtual
need to protect the \ passed on the makefile on my Mac
Bib: Updated ref
update src/mat/examples/tests/output/ex23_#.out
rename MatGetSubMat -> MatCreateSubMat
Mark MatCreateMPIAIJWithSplitArrays() and MatMPIAIJSetPreallocationCSR() with MAT_NO_OFF_PROC_ENTRIES
superlu: libray is installed in PREFIX/lib64 - fix this to use PREFIX/lib
backport fixes cc105cc3 2b35c90a - required for 3bf428d - that was backported from master - 80c96bb
'echo -n' fails on opensolaris/osx - so avoid using it.
fix diffs in nightlybuilds due to options in ~/.petscrc
add Kelley03 to src/docs/tex/petsc.bib
build: determine moudles, mpi.h used during buildtime and print in 'info'
fix analyzer warnings
fix build failure on opensolaris - where -lm from flibs is removed due to -lm in cxxlibs. But then - only flib gets used for some configure tests [blaslapack, parms]
config: prefer __restrict over C99 restrict keyword
...

show more ...

Merge branch 'barry/remove-funct'

Remove the use and definition of __FUNCT__ throughout the code

Since all modern C/C++ compilers provide this functionality we no longer need to provide it manually in PETSc
Time: 1.5 hours
Thanks-t

Remove the use and definition of __FUNCT__ throughout the code

Since all modern C/C++ compilers provide this functionality we no longer need to provide it manually in PETSc
Time: 1.5 hours
Thanks-to: Andreas Mang <andreas@ices.utexas.edu>

show more ...

Merge branch 'master' into barry/fix-successful-numerical-factorization-after-failure/master

The maint patch for the given problem cannot merge cleanly into next due to changes
in the same code in m

Merge branch 'master' into barry/fix-successful-numerical-factorization-after-failure/master

The maint patch for the given problem cannot merge cleanly into next due to changes
in the same code in master (the introduction of MatFactorGetError()) therefor need
to merge in master and use the new construct before merging to next

show more ...