Commit 1bb3edfd authored by Patrick Sanan's avatar Patrick Sanan
Browse files

Docs: remove "Concepts:" and related comments in /*T .. T*/ blocks

Remove all \*T ... comment blocks with e.g.

   cd src && find . -type f -exec sed -i '/^[! ] *\/\*T$/,/^[! ]*T\*\/$/d' {} \;

Clean up resulting double blank lines with e.g.

   cd src &&  find . type f \( -name "*.c" -o -name "*.cxx" -o -name "*.F" -o -name "*.F90" \) -exec sh -c "cat -s {} > tmp && mv tmp {}" \;

Manually revert those changes from the vendored code (src/sys/yaml)

Manually restore a few comments from these blocks.

Manually remove "Concepts:" and "Processors:" comments from files
which have these outside of "\*T" blocks automatically deleted above.
parent 6cace447
......@@ -12,11 +12,6 @@ Input parameters include:
-n <mesh_n> : number of mesh points in y-direction
Concepts: KSP^basic parallel example
Concepts: KSP^Laplacian, 2d
Concepts: Laplacian, 2d
Processors: n
Vec x,b,u; # approx solution, RHS, exact solution
Mat A; # linear system matrix
KSP ksp; # linear solver context
......
......@@ -5,8 +5,6 @@ https://petsc.org/release/src/ksp/ksp/tutorials/ex23.c.html
By: Miguel Arriaga
Solves a tridiagonal linear system.
Concepts: KSP^basic parallel example
Processors: n
Vec x, b, u; approx solution, RHS, exact solution
Mat A; linear system matrix
......
static char help[] = "Demonstrates various vector routines for DMDA.\n\n";
/*T
Concepts: mathematical functions
Processors: n
T*/
/*
Include "petscpf.h" so that we can use pf functions and "petscdmda.h" so
we can use the PETSc distributed arrays
......
static char help[] = "Demonstrates using PetscViewerPushFormat(viewer,PETSC_VIEWER_BINARY_MATLAB)\n\n";
/*T
Concepts: viewers
Concepts: bags
Processors: n
T*/
#include <petscsys.h>
#include <petscdm.h>
#include <petscdmda.h>
......
static char help[] = "Demonstrates HDF5 vector input/ouput\n\n";
/*T
Concepts: viewers
Concepts: HDF5
Processors: n
T*/
#include <petscsys.h>
#include <petscdm.h>
#include <petscdmda.h>
......
......@@ -18,12 +18,6 @@ The command line options include:\n\
-Nx <npx>, where <npx> = number of processors in the x-direction\n\
-Ny <npy>, where <npy> = number of processors in the y-direction\n\n";
/*T
Concepts: KSP^writing a user-defined nonlinear solver (parallel Bratu example);
Concepts: DMDA^using distributed arrays;
Processors: n
T*/
/* ------------------------------------------------------------------------
Solid Fuel Ignition (SFI) problem. This problem is modeled by
......
......@@ -2,10 +2,6 @@ static const char help[] = "Tests MatGetSchurComplement\n";
#include <petscksp.h>
/*T
Concepts: Mat, Schur Complement
T*/
PetscErrorCode Create(MPI_Comm comm,Mat *inA,IS *is0,IS *is1)
{
Mat A;
......
static char help[] = "Test procedural KSPSetFromOptions() or at runtime; Test PCREDUNDANT.\n\n";
/*T
Concepts: KSP^basic parallel example;
Processors: n
T*/
#include <petscksp.h>
int main(int argc,char **args)
......
......@@ -20,10 +20,6 @@ It is copied and intended to move dirty codes from ksp/tutorials/ex10.c and simp
./ex30 -f0 $D/small -mat_sigma -3.999999999999999 -ksp_type fgmres -pc_type lu -pc_factor_mat_solver_type petsc -pc_factor_shift_type NONZERO -pc_factor_shift_amount 1.e-5 -ckerror
\n\n";
*/
/*T
Concepts: KSP solving a linear system
Processors: n
T*/
#include <petscksp.h>
......
......@@ -4,11 +4,6 @@ This Input parameters include\n\
-f <input_file> : file to load \n\
-partition -mat_partitioning_view \n\\n";
/*T
Concepts: KSP^solving a linear system
Processors: n
T*/
#include <petscksp.h>
int main(int argc,char **args)
......
......@@ -14,13 +14,6 @@ difference. Input parameters include:\n\
-gamma : gamma (default 4/h)\n\
-beta : beta (default 0.01/h^2)\n\n";
/*T
Concepts: KSP^basic parallel example;
Concepts: KSP^Laplacian, 2d
Concepts: Laplacian, 2d
Processors: n
T*/
/*
Include "petscksp.h" so that we can use KSP solvers. Note that this file
automatically includes:
......
......@@ -6,13 +6,6 @@ Input parameters include:\n\
-m <mesh_x> : number of mesh points in x-direction\n\
-n <mesh_y> : number of mesh points in y-direction\n\n";
/*T
Concepts: KSP^basic parallel example;
Concepts: KSP^Laplacian, 2d
Concepts: Laplacian, 2d
Processors: n
T*/
/*
Include "petscksp.h" so that we can use KSP solvers. Note that this file
automatically includes:
......
static const char help[]="Example demonstrating PCCOMPOSITE where one of the inner PCs uses a different operator\n\
\n";
/*T
Concepts: KSP^using nested solves
Concepts: PC^using composite PCs
Processors: n
T*/
#include <petscksp.h>
int main(int argc, char **argv)
......
static char help[] = "Solves a tridiagonal linear system with KSP.\n\n";
/*T
Concepts: KSP^solving a system of linear equations
Processors: 1
T*/
/*
Modified from ex1.c for testing matrix operations when matrix structure is changed.
Contributed by Jose E. Roman, Feb. 2012.
......
......@@ -3,11 +3,6 @@
! use of a user-provided preconditioner. Input parameters include:
!
!
!!/*T
! Concepts: KSP^basic parallel example
! Concepts: PC^setting a user-defined shell preconditioner
! Processors: n
!T*/
!
! -------------------------------------------------------------------------
......
static char help[] = "Solves an ill-conditioned tridiagonal linear system with KSP for testing GMRES breakdown tolerance.\n\n";
/*T
Concepts: KSP^solving an ill-conditioned system of linear equations for testing GMRES breakdown tolerance
Processors: 1
T*/
#include <petscksp.h>
int main(int argc,char **args)
......
static char help[] = "Solves a tridiagonal linear system with KSP.\n\n";
/*T
Concepts: KSP^solving a system of linear equations
Processors: 1
T*/
/*
Include "petscksp.h" so that we can use KSP solvers. Note that this file
automatically includes:
......
......@@ -4,13 +4,6 @@ static char help[] = "Solve a small system and a large system through preloading
-permute <natural,rcm,nd,...> : solve system in permuted indexing\n\
-f0 <small_sys_binary> -f1 <large_sys_binary> \n\n";
/*T
Concepts: KSP^basic parallel example
Concepts: Mat^loading a binary matrix and vector;
Concepts: PetscLog^preloading executable
Processors: n
T*/
/*
Include "petscksp.h" so that we can use KSP solvers. Note that this file
automatically includes:
......
static char help[] = "Solves a linear system in parallel with KSP.\n\n";
/*T
Concepts: KSP^solving a Helmholtz equation
Concepts: complex numbers;
Concepts: Helmholtz equation
Processors: n
T*/
/*
Description: Solves a complex linear system in parallel with KSP.
......
!
! Description: Solves a complex linear system in parallel with KSP (Fortran code).
!
!!/*T
! Concepts: KSP^solving a Helmholtz equation
! Concepts: complex numbers
! Processors: n
!T*/
!
! The model problem:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment