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 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/fix-plex-project-tests

* master: (477 commits)
Added correct report number for PETSc Developers Guide
Update PETSc Developers Guide title and final pages to ne

Merge branch 'master' into knepley/fix-plex-project-tests

* master: (477 commits)
Added correct report number for PETSc Developers Guide
Update PETSc Developers Guide title and final pages to new ANL style
Hash: Quick documentation fix
PetscBinaryViewerRead -> PetscViewerBinaryRead
cast in GAMG_HASH so that it works for PetscInt32 near PETSC_INT_MAX without overflow to negative numbers
Add link for DrMemory which may serve as an alternative to valgrind on Windows
Finish Gail's copyedits for developers manual.
openmpi: fix namespace conflict [with static build on ppc64le]
two pages of Gail's edits to developers guide
Another chapter of Gail's copyedits for the developers guide
Gail's copyedits on two more chapters of the developers guide
Fix more %d to %D in GAMG code. Fix code style in GAMG code
DMPlexVTK: vertices is int! need to use %d instead of %D
TS ex18: update outputs (reported by nightly tests)
Use %D in error messages for GAMG hash; fix style issues with GAMG hash
config: Update petsc4py git commit
Fix bad plain extern declaration.
Add Gail's copyedits for the initial portion of the developers guide
Add missing common block to subroutine
fix mpiuni tests with xl compilers
...

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 'knepley/feature-error-logging' of bitbucket.org:petsc/petsc into knepley/feature-error-logging

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

* master: (324 commits)
DT: Reverting the tgamma change broke MPFR - I guess we need a nightly build with it in
Revert "tgamma: icc on wi

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

* master: (324 commits)
DT: Reverting the tgamma change broke MPFR - I guess we need a nightly build with it in
Revert "tgamma: icc on windows requires mathimf.h for tgamma."
setup routine no longer calls PetscCalloc5 if the arrays have already been allocated in a previous setup call
clarify SNESGetFunction()
Move MOAB docs to submansec so as not to clutter DM mansec
doc: remove matlab from doc generation dependency - i.e remove 'alldoc3' and use 'html' to generate corresponding '*.m.html' files.
Remove matlab pounders related cruft that is not required. Document the matlab code better and include an appropriate message in the help text.
Fixed typo.
Remove the inclusion of matlab in testing.
Finalizing comments and the work for the test problems.
Finished the testing and generation of plots. Some simple bug fixes addressed.
Set -Wl,-rpath for Mac OS Matlab mkl directory; don't pass -nojvm to matlab since it causes crashes on Barry's machine and is not needed
Added list of known problems with the code.
Added a comment on ignoring the return from Tao.
Finish with initial implementation of matlab interface to test TAO pounders.
Working through the matlab interface for pounders testing.
Fix typo in manual Reported-by: Jaroslaw Piwonski (CAU) <jpi@informatik.uni-kiel.de>
Fixed mkl_sparse_sypr() calls that were using an unsupported value in the matrix descriptor.
test harness: simplify code that checks for sequential-only tests
Fix the doc for call-backs drdyf drdpf
...

show more ...

Merge remote-tracking branch 'origin/barry/dmda-calls-type-check'

Add runtime checking if DMDA methods are called with other DM types

Commit-type: feature
Reported-by: Danyang Su <danyang.su@gmail.com>

Merge branch 'master' into knepley/feature-snes-ex13-spectral

* master: (2350 commits)
migrate warning fix from next-tmp
Revert "Remove dead code."
clarifying comment in the code
Remove dead

Merge branch 'master' into knepley/feature-snes-ex13-spectral

* master: (2350 commits)
migrate warning fix from next-tmp
Revert "Remove dead code."
clarifying comment in the code
Remove dead code.
Add JuMP citation
Copyedits and updates to developers manual
Add more protection to intrinsics
MPI: protect arguments in MPI macros
Add the missing conditionals for 64-bit build
Plex+VTK: Fix field type determination
Fix bug in name cleanup
Bib: Added ref
Plex+VTK: Fix field type determination
Plex: Updated test output - I am now hating this shit
forgot to save file after moving prototypes to petscsys.h
update Apple example project settings per Xcode
Two functions should actually be public, used, for example from Apple MacOS and iOS programs
includes should always be included relative to include directory
Apple removed old locations of docsets
SNES ex12: Updated test output
...

Conflicts:
src/snes/examples/tutorials/ex13.c

show more ...

Merge branch 'barry/add-fortran-custom-interfaces'

a few more Fortran interfaces

Commit-type: feature

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 pr263/PierreBdR/ts-domain-error-in-stage/master

Merge branch 'barry/fix-nonew-notcollective/maint' into jed/mat-assembly-perf

Jed this fucking 6+ month running thing in next that is not in master is a royal fucking pain in the ass and
an abuse of

Merge branch 'barry/fix-nonew-notcollective/maint' into jed/mat-assembly-perf

Jed this fucking 6+ month running thing in next that is not in master is a royal fucking pain in the ass and
an abuse of git. I think it is not justified to ever have anything in next for more than a few weeks at most.
Either take it out of next if it is broken or put it in master if it is not broken. Hanging around in next but
not master for ever is not a good policy.

show more ...

Merge branch 'master' into knepley/solkx

* master: (6933 commits)
Bib: Added reference
Includegraph: Updated for compatibility with new folder layout.
Add SNESLineSearchReason to fortran inclu

Merge branch 'master' into knepley/solkx

* master: (6933 commits)
Bib: Added reference
Includegraph: Updated for compatibility with new folder layout.
Add SNESLineSearchReason to fortran includes Also truncate names to fit 32 char fortran limit
fix compile warnings /usr/home/balay/petsc.clone-2/src/vec/vec/interface/vector.c:1944: warning: division by zero in '1.0e+0 / 0.' /usr/home/balay/petsc.clone-2/src/ksp/ksp/interface/itfunc.c:508: warning: 'vec_rhs' may be used uninitialized in this function
updated output for new trust region initial size
initial size of the trust region is set as a percent of the norm of the initial guess, it should not be related to the initial norm of the function (which is kind of nuts).
The default bounds for SNESVISetVariableBounds() in the manual page were reversed from correct values
Bib: Added refs
Bib: Update MPICH webpage
Plex: Forgot to close file
removed nonexistent ex46f from makefile test rule
Revert "fixed bad merge into master"
fixed bad merge into master
fix memory leak in mkl_pardiso fix some formatting in mkl_pardiso code
mv runex111 from TESTEXAMPLES_C to TESTEXAMPLES_DATAFILESPATH
Mat+Doc: More Fortran docs
Plex ex3: Run tests with the correct number of field components
Bib: Added TetGen cite
parmetis: make sure 'ldd libparmetis.so' points to the correct libmetis.so that its linked with.
small fix as reported by the nightly test
...

Conflicts:
config/builder.py

show more ...

Merge branch 'master' into tisaac/dmforest

directory layout changed again: merging to switching branches back and forth
doesn't cause reconfigure to have a hard time

* master: (357 commits)
remov

Merge branch 'master' into tisaac/dmforest

directory layout changed again: merging to switching branches back and forth
doesn't cause reconfigure to have a hard time

* master: (357 commits)
removed nonexistent ex46f from makefile test rule
Revert "fixed bad merge into master"
fixed bad merge into master
fix memory leak in mkl_pardiso fix some formatting in mkl_pardiso code
mv runex111 from TESTEXAMPLES_C to TESTEXAMPLES_DATAFILESPATH
Mat+Doc: More Fortran docs
Bib: Added TetGen cite
parmetis: make sure 'ldd libparmetis.so' points to the correct libmetis.so that its linked with.
small fix as reported by the nightly test
add a test for MatPtAP()
small cleanup; add tests
cleanup MatPtAPSymbolic_MPIAIJ_MPIAIJ()
Fix nonzerostate tracking in all MATMPI types.
update location of test matrices in faq.html file
unused variable still declared
Fix for MatLoad_MPIDense() from sparsely stored matrix also fix for MatLoad_MPIDense_DenseInFile() when matrix has not had its local sizes preset by user
Preserve the B nonzerostate during disassembly.
TSEvent: Fix arch-mswin nightly errors due to declaring variables in the middle of a function.
Fix error in parallel loading of dense format matrix
removed KSPSetNullSpace() since mat already carries that information and having two locations for it is confusing, unnecessary and prone to error added MatSetTransposeNullSpace() for providing the null space of the transpose of the matrix and added support in KSPSolve() to remove this null space from the right handside of the linear system thus making the system consistent.
...

show more ...

Merge branch 'master' into knepley/feature-composable-callbacks

* master: (151 commits)
PetscMalloc: Fix handling of zero-sized allocations
add note to DMGetLocal/GlobalVector() about intended s

Merge branch 'master' into knepley/feature-composable-callbacks

* master: (151 commits)
PetscMalloc: Fix handling of zero-sized allocations
add note to DMGetLocal/GlobalVector() about intended short-time usage of the vectors.
sf: use patched openmpi tarball that has a potential fix for sf example hang
SNES problems that set VI bounds must use a VI solver since the other solvers ignore the bounds
pounders viewer did not cast PetscReal to double in printf nor use %D instead of %d
fix ts ex20adj
fix ts theta
fixed another variable declaration in the middle of a code block
example main() had PetscInt return type and argument that should be int
DMDAVTKWriteAll_VTS: Fix handling of higher-dimension coordinates
fixed example that declared variables in the middle of a function
C programs do not return PetscInt nor do they take an argument that is PetscInt, fixed example that did
You cannot declare variables in the middle of functions in PETSc.
add ierr checking to PetscOptionsBegin/End() in example
configure: add error check if user specifies PETSC_ARCH=-dbg [i.e starts with a '-']
scale norm of vector difference by norm of vector to insure it is small enough to consider the two vectors equal
missing PetscViewerDestroy() added
MatNestGetISs: use custom fortranstub to handle PETSC_NULL_OBJECT
update location of open-mx website on FAQ page
If the user sets bounds and calls a solver that does not support them, throw an error.
...

show more ...