Docs: Fix man page .seealso entries missing spaces after commas

```python

import os
import re
import fileinput

START_PATTERN = re.compile(r"^( *\.seealso:? )(.*$)")
FIX_PATTERN = re.compile(r",([^

Docs: Fix man page .seealso entries missing spaces after commas

```python

import os
import re
import fileinput

START_PATTERN = re.compile(r"^( *\.seealso:? )(.*$)")
FIX_PATTERN = re.compile(r",([^ $\n])")

def _fix_comma(matchobj):
return "`, `%s" % matchobj.group(1)

def process_file(filename_full):
""" Find/fix commas w/o trailing spaces or newlines in .seealso blocks """
with fileinput.FileInput(filename_full, inplace=True) as the_file:
in_block = False
for line in the_file:
line_stripped = line.strip()
# end ".seealso blocks" on a blank line or C-style comment close
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:
in_block = True
if in_block:
if re.search(FIX_PATTERN, line):
line_fixed = re.sub(FIX_PATTERN, _fix_comma, line)
print(line_fixed, end="") # prints to file
else:
print(line, end="") # prints to file
else:
print(line, end="") # prints to 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 files in local tree(s) """
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)
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 '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/2022-03-19/rm-ts-petsccheckfalse' into 'main'

Remove many PetscCheckFalse() from ts

See merge request petsc/petsc!4996

Remove many PetscCheckFalse() from ts

Commit-type: style-fix
/spend 1h
Thanks-to: Jose E. Roman <jroman@dsic.upv.es>

Merge branch 'jacobf/2022-01-05/c99' into 'main'

Feature: C99 and C++11

See merge request petsc/petsc!4700

rename PetscAssert() -> PetscCheck() and PetscAssertDebug() -> PetscAssert()

add PetscAssert() and PetscAssertFalse()

Merge remote-tracking branch 'origin/jose/fix-manpages'

Fix manpages to avoid errors reported by doctext

See merge request petsc/petsc!4309

Fix manpages: Argument --> Parameter (required to enable sowing checks)

Fix manpages: mismatching number of parameters

Merge branch 'barry/2021-05-16/fix-double-lines' into 'main'

Fix typos in source

See merge request petsc/petsc!3984

Remove all double blank lines from source

Commit-type: petsc-style
/2h

Merge branch 'barry/2020-08-04/tssettransientvarible-calling-sequence' into 'master'

Add calling sequence for function provided to TSSetTransientVariable

See merge request petsc/petsc!3022

Add calling sequence for function provided to TSSetTransientVariable
Fix other TS manual pages

Commit-type: documentation
/spend 10m
Reported-by: Kyle B. Thompson <kyle.b.thompson@nasa.gov>

Merge remote-tracking branch 'origin/dalcinl/fix-null'

TS/SNES/Tao: Fix 0 ->NULL for pointers

See merge request petsc/petsc!2783

TS: Replace 0 -> NULL for pointers

Merge branch 'dalcinl/binary-io' into 'master'

Binary IO Enhancements

See merge request petsc/petsc!2594

PetscBinaryWrite: Remove `istemp` boolean flag

Merge branch 'jed/ts-transient-var' into 'master'

Jed/ts transient var

Closes #547

See merge request petsc/petsc!2557

TS: add TSSetTransientVariable (alias for DMTSSetTransientVariable)

Requested-by: Hong Zhang <hongzhang@anl.gov>

TS: add support for transient variables in BDF

This feature enables conservative time integration even when using
nonconservative state variables. The formulation, which requires only
the definitio

TS: add support for transient variables in BDF

This feature enables conservative time integration even when using
nonconservative state variables. The formulation, which requires only
the definition of transient (conservative) variables C(U) as a
function of the state variable U, is appropriate for linear multistep
methods for ODE and DAE.

This technique could be extended to Runge-Kutta methods by creating an
index-1 DAE by augmentation with the equation C = C(U). The stage
equations in diagonally implicit methods generally ask to solve for Y:

F(Y, alpha Y + Z) = 0

where Y = [C, U] and Z is known from prior stages. With the augmented
equation, this decouples to

C - C(U) = 0
f(U, alpha C + C_z) = 0

This commit includes an example demonstrating loss of conservation in
chain rule primitive-variable IFunction, while preserving it for
pure-conservative variables and the transient variable formulation.

Resolves #547

Requested-by: Gautam Bisht <gautam.bisht@pnnl.gov>
Thanks-to: Hong Zhang <hongzhang@anl.gov>

show more ...