Skip to content

Commit f82c40a

Browse files
joseeromanjoseeroman
committed
Merge branch 'jose/fix-manpages-collective' into 'main'
Remove unneeded ' on xxx' from most Collective comments in manpages See merge request slepc/slepc!475
2 parents 682acd4 + a0cfef6 commit f82c40a

File tree

113 files changed

+707
-708
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+707
-708
lines changed

‎src/binding/slepc4py/src/SLEPc/EPS.pyx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2001,7 +2001,6 @@ cdef class EPS(Object):
20012001
20022002
Notes
20032003
-----
2004-
Logically Collective on EPS
20052004
This function must be called after setKrylovSchurPartitions().
20062005
For npart partitions, the argument subint must contain npart+1
20072006
real values sorted in ascending order:

‎src/eps/impls/cg/lobpcg/lobpcg.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ static PetscErrorCode EPSLOBPCGSetBlockSize_LOBPCG(EPS eps,PetscInt bs)
411411
/*@
412412
EPSLOBPCGSetBlockSize - Sets the block size of the LOBPCG method.
413413
414-
Logically Collective on eps
414+
Logically Collective
415415
416416
Input Parameters:
417417
+ eps - the eigenproblem solver context
@@ -483,7 +483,7 @@ static PetscErrorCode EPSLOBPCGSetRestart_LOBPCG(EPS eps,PetscReal restart)
483483
/*@
484484
EPSLOBPCGSetRestart - Sets the restart parameter for the LOBPCG method.
485485
486-
Logically Collective on eps
486+
Logically Collective
487487
488488
Input Parameters:
489489
+ eps - the eigenproblem solver context
@@ -557,7 +557,7 @@ static PetscErrorCode EPSLOBPCGSetLocking_LOBPCG(EPS eps,PetscBool lock)
557557
EPSLOBPCGSetLocking - Choose between locking and non-locking variants of
558558
the LOBPCG method.
559559
560-
Logically Collective on eps
560+
Logically Collective
561561
562562
Input Parameters:
563563
+ eps - the eigenproblem solver context

‎src/eps/impls/cg/rqcg/rqcg.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ static PetscErrorCode EPSRQCGSetReset_RQCG(EPS eps,PetscInt nrest)
259259
EPSRQCGSetReset - Sets the reset parameter of the RQCG iteration. Every
260260
nrest iterations, the solver performs a Rayleigh-Ritz projection step.
261261
262-
Logically Collective on eps
262+
Logically Collective
263263
264264
Input Parameters:
265265
+ eps - the eigenproblem solver context

‎src/eps/impls/ciss/ciss.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -712,7 +712,7 @@ static PetscErrorCode EPSCISSSetSizes_CISS(EPS eps,PetscInt ip,PetscInt bs,Petsc
712712
/*@
713713
EPSCISSSetSizes - Sets the values of various size parameters in the CISS solver.
714714
715-
Logically Collective on eps
715+
Logically Collective
716716
717717
Input Parameters:
718718
+ eps - the eigenproblem solver context
@@ -820,7 +820,7 @@ static PetscErrorCode EPSCISSSetThreshold_CISS(EPS eps,PetscReal delta,PetscReal
820820
EPSCISSSetThreshold - Sets the values of various threshold parameters in
821821
the CISS solver.
822822
823-
Logically Collective on eps
823+
Logically Collective
824824
825825
Input Parameters:
826826
+ eps - the eigenproblem solver context
@@ -904,7 +904,7 @@ static PetscErrorCode EPSCISSSetRefinement_CISS(EPS eps,PetscInt inner,PetscInt
904904
EPSCISSSetRefinement - Sets the values of various refinement parameters
905905
in the CISS solver.
906906
907-
Logically Collective on eps
907+
Logically Collective
908908
909909
Input Parameters:
910910
+ eps - the eigenproblem solver context
@@ -979,7 +979,7 @@ static PetscErrorCode EPSCISSSetUseST_CISS(EPS eps,PetscBool usest)
979979
EPSCISSSetUseST - Sets a flag indicating that the CISS solver will
980980
use the ST object for the linear solves.
981981
982-
Logically Collective on eps
982+
Logically Collective
983983
984984
Input Parameters:
985985
+ eps - the eigenproblem solver context
@@ -1050,7 +1050,7 @@ static PetscErrorCode EPSCISSSetQuadRule_CISS(EPS eps,EPSCISSQuadRule quad)
10501050
/*@
10511051
EPSCISSSetQuadRule - Sets the quadrature rule used in the CISS solver.
10521052
1053-
Logically Collective on eps
1053+
Logically Collective
10541054
10551055
Input Parameters:
10561056
+ eps - the eigenproblem solver context
@@ -1127,7 +1127,7 @@ static PetscErrorCode EPSCISSSetExtraction_CISS(EPS eps,EPSCISSExtraction extrac
11271127
/*@
11281128
EPSCISSSetExtraction - Sets the extraction technique used in the CISS solver.
11291129
1130-
Logically Collective on eps
1130+
Logically Collective
11311131
11321132
Input Parameters:
11331133
+ eps - the eigenproblem solver context

‎src/eps/impls/davidson/gd/gd.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ PetscErrorCode EPSDestroy_GD(EPS eps)
131131
EPSGDSetKrylovStart - Activates or deactivates starting the searching
132132
subspace with a Krylov basis.
133133
134-
Logically Collective on eps
134+
Logically Collective
135135
136136
Input Parameters:
137137
+ eps - the eigenproblem solver context
@@ -184,7 +184,7 @@ PetscErrorCode EPSGDGetKrylovStart(EPS eps,PetscBool *krylovstart)
184184
EPSGDSetBlockSize - Sets the number of vectors to be added to the searching space
185185
in every iteration.
186186
187-
Logically Collective on eps
187+
Logically Collective
188188
189189
Input Parameters:
190190
+ eps - the eigenproblem solver context
@@ -235,7 +235,7 @@ PetscErrorCode EPSGDGetBlockSize(EPS eps,PetscInt *blocksize)
235235
EPSGDSetRestart - Sets the number of vectors of the searching space after
236236
restarting and the number of vectors saved from the previous iteration.
237237
238-
Logically Collective on eps
238+
Logically Collective
239239
240240
Input Parameters:
241241
+ eps - the eigenproblem solver context
@@ -288,7 +288,7 @@ PetscErrorCode EPSGDGetRestart(EPS eps,PetscInt *minv,PetscInt *plusk)
288288
/*@
289289
EPSGDSetInitialSize - Sets the initial size of the searching space.
290290
291-
Logically Collective on eps
291+
Logically Collective
292292
293293
Input Parameters:
294294
+ eps - the eigenproblem solver context
@@ -354,7 +354,7 @@ PetscErrorCode EPSGDGetInitialSize(EPS eps,PetscInt *initialsize)
354354
EPSGDSetBOrth - Selects the orthogonalization that will be used in the search
355355
subspace in case of generalized Hermitian problems.
356356
357-
Logically Collective on eps
357+
Logically Collective
358358
359359
Input Parameters:
360360
+ eps - the eigenproblem solver context
@@ -413,7 +413,7 @@ static PetscErrorCode EPSGDSetDoubleExpansion_GD(EPS eps,PetscBool doubleexp)
413413
/*@
414414
EPSGDSetDoubleExpansion - Activate the double expansion variant of GD.
415415
416-
Logically Collective on eps
416+
Logically Collective
417417
418418
Input Parameters:
419419
+ eps - the eigenproblem solver context

‎src/eps/impls/davidson/jd/jd.c

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ PetscErrorCode EPSDestroy_JD(EPS eps)
161161
EPSJDSetKrylovStart - Activates or deactivates starting the searching
162162
subspace with a Krylov basis.
163163
164-
Logically Collective on eps
164+
Logically Collective
165165
166166
Input Parameters:
167167
+ eps - the eigenproblem solver context
@@ -214,7 +214,7 @@ PetscErrorCode EPSJDGetKrylovStart(EPS eps,PetscBool *krylovstart)
214214
EPSJDSetBlockSize - Sets the number of vectors to be added to the searching space
215215
in every iteration.
216216
217-
Logically Collective on eps
217+
Logically Collective
218218
219219
Input Parameters:
220220
+ eps - the eigenproblem solver context
@@ -265,7 +265,7 @@ PetscErrorCode EPSJDGetBlockSize(EPS eps,PetscInt *blocksize)
265265
EPSJDSetRestart - Sets the number of vectors of the searching space after
266266
restarting and the number of vectors saved from the previous iteration.
267267
268-
Logically Collective on eps
268+
Logically Collective
269269
270270
Input Parameters:
271271
+ eps - the eigenproblem solver context
@@ -318,7 +318,7 @@ PetscErrorCode EPSJDGetRestart(EPS eps,PetscInt *minv,PetscInt *plusk)
318318
/*@
319319
EPSJDSetInitialSize - Sets the initial size of the searching space.
320320
321-
Logically Collective on eps
321+
Logically Collective
322322
323323
Input Parameters:
324324
+ eps - the eigenproblem solver context
@@ -395,7 +395,7 @@ PetscErrorCode EPSJDSetFix_JD(EPS eps,PetscReal fix)
395395
EPSJDSetFix - Sets the threshold for changing the target in the correction
396396
equation.
397397
398-
Logically Collective on eps
398+
Logically Collective
399399
400400
Input Parameters:
401401
+ eps - the eigenproblem solver context
@@ -475,7 +475,7 @@ PetscErrorCode EPSJDSetConstCorrectionTol_JD(EPS eps,PetscBool constant)
475475
(also called Newton) that sets the KSP relative tolerance
476476
to 0.5**i, where i is the number of EPS iterations from the last converged value.
477477
478-
Logically Collective on eps
478+
Logically Collective
479479
480480
Input Parameters:
481481
+ eps - the eigenproblem solver context
@@ -539,7 +539,7 @@ PetscErrorCode EPSJDGetConstCorrectionTol(EPS eps,PetscBool *constant)
539539
EPSJDSetBOrth - Selects the orthogonalization that will be used in the search
540540
subspace in case of generalized Hermitian problems.
541541
542-
Logically Collective on eps
542+
Logically Collective
543543
544544
Input Parameters:
545545
+ eps - the eigenproblem solver context

‎src/eps/impls/external/blopex/blopex.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ static PetscErrorCode EPSBLOPEXSetBlockSize_BLOPEX(EPS eps,PetscInt bs)
283283
/*@
284284
EPSBLOPEXSetBlockSize - Sets the block size of the BLOPEX solver.
285285
286-
Logically Collective on eps
286+
Logically Collective
287287
288288
Input Parameters:
289289
+ eps - the eigenproblem solver context

‎src/eps/impls/external/evsl/evsl.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ static PetscErrorCode EPSEVSLSetSlices_EVSL(EPS eps,PetscInt nslices)
274274
EPSEVSLSetSlices - Set the number of slices in which the interval must be
275275
subdivided.
276276
277-
Logically Collective on eps
277+
Logically Collective
278278
279279
Input Parameters:
280280
+ eps - the eigensolver context
@@ -353,7 +353,7 @@ static PetscErrorCode EPSEVSLSetRange_EVSL(EPS eps,PetscReal lmin,PetscReal lmax
353353
EPSEVSLSetRange - Defines the numerical range (or field of values) of the problem,
354354
that is, the interval containing all eigenvalues.
355355
356-
Logically Collective on eps
356+
Logically Collective
357357
358358
Input Parameters:
359359
+ eps - the eigensolver context
@@ -459,7 +459,7 @@ static PetscErrorCode EPSEVSLSetDOSParameters_EVSL(EPS eps,EPSEVSLDOSMethod dos,
459459
EPSEVSLSetDOSParameters - Defines the parameters used for computing the
460460
density of states (DOS) in the EVSL solver.
461461
462-
Logically Collective on eps
462+
Logically Collective
463463
464464
Input Parameters:
465465
+ eps - the eigensolver context
@@ -563,7 +563,7 @@ static PetscErrorCode EPSEVSLSetPolParameters_EVSL(EPS eps,PetscInt max_deg,Pets
563563
EPSEVSLSetPolParameters - Defines the parameters used for building the
564564
building the polynomial in the EVSL solver.
565565
566-
Logically Collective on eps
566+
Logically Collective
567567
568568
Input Parameters:
569569
+ eps - the eigensolver context
@@ -638,7 +638,7 @@ static PetscErrorCode EPSEVSLSetDamping_EVSL(EPS eps,EPSEVSLDamping damping)
638638
/*@
639639
EPSEVSLSetDamping - Set the type of damping to be used in EVSL.
640640
641-
Logically Collective on eps
641+
Logically Collective
642642
643643
Input Parameters:
644644
+ eps - the eigensolver context

‎src/eps/impls/external/feast/feast.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ static PetscErrorCode EPSFEASTSetNumPoints_FEAST(EPS eps,PetscInt npoints)
263263
EPSFEASTSetNumPoints - Sets the number of contour integration points for
264264
the FEAST package.
265265
266-
Collective on EPS
266+
Logically Collective
267267
268268
Input Parameters:
269269
+ eps - the eigenproblem solver context
@@ -298,7 +298,7 @@ static PetscErrorCode EPSFEASTGetNumPoints_FEAST(EPS eps,PetscInt *npoints)
298298
EPSFEASTGetNumPoints - Gets the number of contour integration points for
299299
the FEAST package.
300300
301-
Collective on EPS
301+
Not Collective
302302
303303
Input Parameter:
304304
. eps - the eigenproblem solver context

‎src/eps/impls/external/primme/primme.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ static PetscErrorCode EPSPRIMMESetBlockSize_PRIMME(EPS eps,PetscInt bs)
434434
/*@
435435
EPSPRIMMESetBlockSize - The maximum block size that PRIMME will try to use.
436436
437-
Logically Collective on eps
437+
Logically Collective
438438
439439
Input Parameters:
440440
+ eps - the eigenproblem solver context
@@ -510,7 +510,7 @@ static PetscErrorCode EPSPRIMMESetMethod_PRIMME(EPS eps,EPSPRIMMEMethod method)
510510
/*@
511511
EPSPRIMMESetMethod - Sets the method for the PRIMME library.
512512
513-
Logically Collective on eps
513+
Logically Collective
514514
515515
Input Parameters:
516516
+ eps - the eigenproblem solver context

‎src/eps/impls/krylov/arnoldi/arnoldi.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ static PetscErrorCode EPSArnoldiSetDelayed_Arnoldi(EPS eps,PetscBool delayed)
157157
EPSArnoldiSetDelayed - Activates or deactivates delayed reorthogonalization
158158
in the Arnoldi iteration.
159159
160-
Logically Collective on eps
160+
Logically Collective
161161
162162
Input Parameters:
163163
+ eps - the eigenproblem solver context

‎src/eps/impls/krylov/krylovschur/krylovschur.c

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ static PetscErrorCode EPSKrylovSchurSetRestart_KrylovSchur(EPS eps,PetscReal kee
351351
method, in particular the proportion of basis vectors that must be kept
352352
after restart.
353353
354-
Logically Collective on eps
354+
Logically Collective
355355
356356
Input Parameters:
357357
+ eps - the eigenproblem solver context
@@ -423,7 +423,7 @@ static PetscErrorCode EPSKrylovSchurSetLocking_KrylovSchur(EPS eps,PetscBool loc
423423
EPSKrylovSchurSetLocking - Choose between locking and non-locking variants of
424424
the Krylov-Schur method.
425425
426-
Logically Collective on eps
426+
Logically Collective
427427
428428
Input Parameters:
429429
+ eps - the eigenproblem solver context
@@ -519,7 +519,7 @@ static PetscErrorCode EPSKrylovSchurSetPartitions_KrylovSchur(EPS eps,PetscInt n
519519
case of doing spectrum slicing for a computational interval with the
520520
communicator split in several sub-communicators.
521521
522-
Logically Collective on eps
522+
Logically Collective
523523
524524
Input Parameters:
525525
+ eps - the eigenproblem solver context
@@ -598,7 +598,7 @@ static PetscErrorCode EPSKrylovSchurSetDetectZeros_KrylovSchur(EPS eps,PetscBool
598598
EPSKrylovSchurSetDetectZeros - Sets a flag to enforce detection of
599599
zeros during the factorizations throughout the spectrum slicing computation.
600600
601-
Logically Collective on eps
601+
Logically Collective
602602
603603
Input Parameters:
604604
+ eps - the eigenproblem solver context
@@ -691,7 +691,7 @@ static PetscErrorCode EPSKrylovSchurSetDimensions_KrylovSchur(EPS eps,PetscInt n
691691
step in case of doing spectrum slicing for a computational interval.
692692
The meaning of the parameters is the same as in EPSSetDimensions().
693693
694-
Logically Collective on eps
694+
Logically Collective
695695
696696
Input Parameters:
697697
+ eps - the eigenproblem solver context
@@ -776,7 +776,7 @@ static PetscErrorCode EPSKrylovSchurSetSubintervals_KrylovSchur(EPS eps,PetscRea
776776
EPSKrylovSchurSetSubintervals - Sets the points that delimit the
777777
subintervals to be used in spectrum slicing with several partitions.
778778
779-
Logically Collective on eps
779+
Logically Collective
780780
781781
Input Parameters:
782782
+ eps - the eigenproblem solver context
@@ -823,7 +823,7 @@ static PetscErrorCode EPSKrylovSchurGetSubintervals_KrylovSchur(EPS eps,PetscRea
823823
EPSKrylovSchurGetSubintervals - Returns the points that delimit the
824824
subintervals used in spectrum slicing with several partitions.
825825
826-
Logically Collective on eps
826+
Not Collective
827827
828828
Input Parameter:
829829
. eps - the eigenproblem solver context
@@ -1148,7 +1148,7 @@ static PetscErrorCode EPSKrylovSchurUpdateSubcommMats_KrylovSchur(EPS eps,PetscS
11481148
EPSKrylovSchurUpdateSubcommMats - Update the eigenproblem matrices stored
11491149
internally in the subcommunicator to which the calling process belongs.
11501150
1151-
Collective on eps
1151+
Collective
11521152
11531153
Input Parameters:
11541154
+ eps - the eigenproblem solver context
@@ -1313,7 +1313,7 @@ static PetscErrorCode EPSKrylovSchurGetKSP_KrylovSchur(EPS eps,KSP *ksp)
13131313
EPSKrylovSchurGetKSP - Retrieve the linear solver object associated with the
13141314
internal EPS object in case of doing spectrum slicing for a computational interval.
13151315
1316-
Collective on eps
1316+
Collective
13171317
13181318
Input Parameter:
13191319
. eps - the eigenproblem solver context

0 commit comments

Comments
 (0)