clang-format: convert PETSc sources to comply with clang-format

Merge branch 'psanan/docs-sphinx-man-pages' into 'main'

Integrate Man Pages into Sphinx Docs

Closes #1132 and #1015

See merge request petsc/petsc!4989

Docs: bulk add backticks to .seealso man page fields

```python
import os
import re
import fileinput

def _process_word(word):
comma = "," if word.endswith(",") else ""
return "`%s`%s" % (wor

Docs: bulk add backticks to .seealso man page fields

```python
import os
import re
import fileinput

def _process_word(word):
comma = "," if word.endswith(",") else ""
return "`%s`%s" % (word.rstrip(","), comma)

def _process_stripped_line(line):
return " ".join(map(_process_word, line.split()))

start_pattern = re.compile(r"^( *\.seealso:? )(.*$)")

def process_file(filename_full):
with fileinput.FileInput(filename_full, inplace=True) as f:
in_block = False
for line in f:
line_stripped = line.strip()
# end ".seealso blocks" on a blank line or C-style comment close
line_modified = None
if not line_stripped:
in_block = False
elif line_stripped.endswith("*/"):
in_block = False
else:
match = re.match(start_pattern,
line) # not stripped line
if match:
indent = " " * len(match.group(1))
in_block = True
line_modified = match.group(
1) + _process_stripped_line(
match.group(2).strip())
elif in_block:
line_modified = indent + _process_stripped_line(
line_stripped)
if line_modified:
print(line_modified) # prints to the file
else:
print(line, end="") # prints to the file

BASE_DIRS = ["src", "include"]
EXT = [".c", ".cxx", ".cpp", ".cu", ".h", ".hpp", ".hxx"]
EXCLUDE_DIRS = ["tests", "tutorials", "ftn-auto", "ftn-custom", "benchmarks"]

def main():
""" Process everything """
for base in BASE_DIRS:
for root, dirs, files in os.walk(base):
for filename in files:
if os.path.splitext(filename)[1] in EXT:
filename_full = os.path.join(root, filename)
print("FILE ---", filename_full)
process_file(filename_full)
for exclude_dir in EXCLUDE_DIRS:
if exclude_dir in dirs:
dirs.remove(exclude_dir)

if __name__ == "__main__":
main()
```

show more ...

Merge branch 'jacobf/2022-02-23/variadic-chkerr' into 'main'

Variadic CHKERRQ()

See merge request petsc/petsc!4889

The great renaming:

- CHKERRQ() -> PetscCall()
- CHKERRV() -> PetscCallVoid()
- CHKERRMPI() -> PetscCallMPI()
- CHKERRABORT() -> PetscCallAbort()
- CHKERRCONTINUE() -> PetscCallContinue()
- CHKERRXX

The great renaming:

- CHKERRQ() -> PetscCall()
- CHKERRV() -> PetscCallVoid()
- CHKERRMPI() -> PetscCallMPI()
- CHKERRABORT() -> PetscCallAbort()
- CHKERRCONTINUE() -> PetscCallContinue()
- CHKERRXX() -> PetscCallThrow()
- CHKERRCXX() -> PetscCallCXX()
- CHKERRCUDA() -> PetscCallCUDA()
- CHKERRCUBLAS() -> PetscCallCUBLAS()
- CHKERRCUSPARSE() -> PetscCallCUSPARSE()
- CHKERRCUSOLVER() -> PetscCallCUSOLVER()
- CHKERRCUFFT() -> PetscCallCUFFT()
- CHKERRCURAND() -> PetscCallCURAND()
- CHKERRHIP() -> PetscCallHIP()
- CHKERRHIPBLAS() -> PetscCallHIPBLAS()
- CHKERRHIPSOLVER() -> PetscCallHIPSOLVER()
- CHKERRQ_CEED() -> PetscCallCEED()
- CHKERR_FORTRAN_VOID_FUNCTION() -> PetscCallFortranVoidFunction()
- CHKERRMKL() -> PetscCallMKL()
- CHKERRMMG() -> PetscCallMMG()
- CHKERRMMG_NONSTANDARD() -> PetscCallMMG_NONSTANDARD()
- CHKERRCGNS() -> PetscCallCGNS()
- CHKERRPTSCOTCH() -> PetscCallPTSCOTCH()
- CHKERRSTR() -> PetscCallSTR()
- CHKERRTC() -> PetscCallTC()

show more ...

chkerr and friends wrapped

Merge branch 'barry/2020-10-08/fix-mpi-error-codes' into 'master'

Convert MPI error type to PETSc error with string message for all MPI calls

See merge request petsc/petsc!3326

Convert MPI error type to PETSc error with string message for all MPI calls

Now PETSc examples will ONLY return PETSc error codes and never MPI error codes directly so we can understand and post-pro

Convert MPI error type to PETSc error with string message for all MPI calls

Now PETSc examples will ONLY return PETSc error codes and never MPI error codes directly so we can understand and post-process their
errors better.

The test harness will now automatically retry tests that fail with MPI, this may help with Intel MPI that produces
seemingly random failures.

Commit-type: error-checking
/spend 30m

show more ...

Merge branch 'barry/2020-08-16/fix-source-formatting' into 'master'

Turn on checkbadSource test to generate an error when found; fix all source code that causes errors

See merge request petsc/petsc

Merge branch 'barry/2020-08-16/fix-source-formatting' into 'master'

Turn on checkbadSource test to generate an error when found; fix all source code that causes errors

See merge request petsc/petsc!3064

show more ...

Turn on checkbadSource test to generate an error when found; fix all source code that causes errors

Commit-type: portability-fix, testing-fix, style-fix, feature, maintainability
/spend 1.5h

Merged in barry/update-collective-on (pull request #1744)

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

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

Merge branch 'master' into jpustay/feature-swarm-example

Merged petsc/petsc into master

Merged petsc/petsc into master

Merge branch 'master' into knepley/feature-dm-nearnullspace

* master: (219 commits)
petsc4py: update with VecScatter API changes
remove duplicate code
petsc4py: update to version 3.10.0
fixe

Merge branch 'master' into knepley/feature-dm-nearnullspace

* master: (219 commits)
petsc4py: update with VecScatter API changes
remove duplicate code
petsc4py: update to version 3.10.0
fixed typos in documentation
fixed typos in documentation
Fix some remaining Register()s to call InitializePackage()
Remove memory leaks of XXXRegister() is called but XXX object is never used
Add to PCTFS manual page that it does not work for complex numbers
Stray , in manual page that should be .
Only register MPI3 VecScatter if they are built
clarification of KSPSetComputeInitialGuess()
Add missing makefiles for VecScatter implementations
Changed VecScatterCreate() to take a communicator and return scatter as other first class PETSc objects do. Changed old VecScatterCreate() to VecScatterCreateWithData()
Added VecScatterSetUp() and converted implementations to use it to compute scatter information
Pull "MPI1" and "MPI3" specific code out of common VecScatter impls code This allows future implementations to use the common code also without changing the common code
Seperate VecScatter implementation code into three subdirectories seq, mpi1, and mpi3
doc: fix author list in manual wrt 6402aee
doc: fix LOCDIR wrt broken URL from MatHYPRESetPreallocation.html
ifort: ifx compile error with --with-mpi=0
changes/310.html: merged two TAO sections
...

Conflicts:
src/dm/interface/dm.c

show more ...

Merge branch 'master' into knepley/feature-ksp-ex10-transpose

* master: (219 commits)
petsc4py: update with VecScatter API changes
remove duplicate code
petsc4py: update to version 3.10.0
fi

Merge branch 'master' into knepley/feature-ksp-ex10-transpose

* master: (219 commits)
petsc4py: update with VecScatter API changes
remove duplicate code
petsc4py: update to version 3.10.0
fixed typos in documentation
fixed typos in documentation
Fix some remaining Register()s to call InitializePackage()
Remove memory leaks of XXXRegister() is called but XXX object is never used
Add to PCTFS manual page that it does not work for complex numbers
Stray , in manual page that should be .
Only register MPI3 VecScatter if they are built
clarification of KSPSetComputeInitialGuess()
Add missing makefiles for VecScatter implementations
Changed VecScatterCreate() to take a communicator and return scatter as other first class PETSc objects do. Changed old VecScatterCreate() to VecScatterCreateWithData()
Added VecScatterSetUp() and converted implementations to use it to compute scatter information
Pull "MPI1" and "MPI3" specific code out of common VecScatter impls code This allows future implementations to use the common code also without changing the common code
Seperate VecScatter implementation code into three subdirectories seq, mpi1, and mpi3
doc: fix author list in manual wrt 6402aee
doc: fix LOCDIR wrt broken URL from MatHYPRESetPreallocation.html
ifort: ifx compile error with --with-mpi=0
changes/310.html: merged two TAO sections
...

Conflicts:
src/ksp/ksp/interface/itfunc.c

show more ...

Merged petsc/petsc into master

Merge branch 'master' into arcowie-rem/feature-error-logging

* master: (345 commits)
Update dev notes for the coming release
Increase patchlevel to 3.9.4
doc fixes
Added some AIJSELL tests t

Merge branch 'master' into arcowie-rem/feature-error-logging

* master: (345 commits)
Update dev notes for the coming release
Increase patchlevel to 3.9.4
doc fixes
Added some AIJSELL tests that mirror the SELL tests.
Bib: More refs
Removed use of hardwired -1 to represent PETSC_NULL_XXX object, since the null value is now 0.
fix memleaks flagged by valgrind
ex62: disable long running test and workaround differences in iteration counts on various builds.
Add FAQ we can point to when users get error messages such as: "PETSc was configured with one OpenMPI mpi.h version but now appears to be compiling using a different OpenMPI mpi.h version"
swith test from mpich to openmpi as mpich ch3:sock is unuserable per PetscShmCommGet()
DM: Forgot to move include statement
fix nightlybuild issues - disable hypre [for openmp] and fix uninitialized variables
tests: enable openmp and hwloc with one of the mumps tests
Default BoomerAMG smoothers
Configure: Revert changes from debb90c, so that we are back to the original Libmesh
Configure: Reverted change for Libmesh from 83cd5d7
Split vecimpl.h into vecimpl.h and vecscatterimpl.h
SNES ex62: Turned off some tests for other precisions and shortened output of sensitive tests
Use mmap to allocate the shared pthread barrier if available
Add configure test for functional mmap
...

Conflicts:
include/petscconvest.h
src/snes/examples/tutorials/ex13.c
src/snes/interface/snes.c
src/snes/utils/convest.c

show more ...

Merge remote-tracking branch 'origin/rmills/feature-add-mataijsell'

Added MATMPIAIJSELL matrix type.