Actual source code: petscpc.h

      1: /*
      2:       Preconditioner module.
      3: */
     6:  #include petscmat.h

      9: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT  PCInitializePackage(const char[]);

     11: /*
     12:     PCList contains the list of preconditioners currently registered
     13:    These are added with the PCRegisterDynamic() macro
     14: */
     16: #define PCType const char*

     18: /*S
     19:      PC - Abstract PETSc object that manages all preconditioners

     21:    Level: beginner

     23:   Concepts: preconditioners

     25: .seealso:  PCCreate(), PCSetType(), PCType (for list of available types)
     26: S*/
     27: typedef struct _p_PC* PC;

     29: /*E
     30:     PCType - String with the name of a PETSc preconditioner method or the creation function
     31:        with an optional dynamic library name, for example
     32:        http://www.mcs.anl.gov/petsc/lib.a:mypccreate()

     34:    Level: beginner

     36:    Notes: Click on the links below to see details on a particular solver

     38: .seealso: PCSetType(), PC, PCCreate()
     39: E*/
     40: #define PCNONE            "none"
     41: #define PCJACOBI          "jacobi"
     42: #define PCSOR             "sor"
     43: #define PCLU              "lu"
     44: #define PCSHELL           "shell"
     45: #define PCBJACOBI         "bjacobi"
     46: #define PCMG              "mg"
     47: #define PCEISENSTAT       "eisenstat"
     48: #define PCILU             "ilu"
     49: #define PCICC             "icc"
     50: #define PCASM             "asm"
     51: #define PCKSP             "ksp"
     52: #define PCCOMPOSITE       "composite"
     53: #define PCREDUNDANT       "redundant"
     54: #define PCSPAI            "spai"
     55: #define PCNN              "nn"
     56: #define PCCHOLESKY        "cholesky"
     57: #define PCSAMG            "samg"
     58: #define PCPBJACOBI        "pbjacobi"
     59: #define PCMAT             "mat"
     60: #define PCHYPRE           "hypre"
     61: #define PCFIELDSPLIT      "fieldsplit"
     62: #define PCTFS             "tfs"
     63: #define PCML              "ml"
     64: #define PCPROMETHEUS      "prometheus"

     66: /* Logging support */

     71: /*E
     72:     PCSide - If the preconditioner is to be applied to the left, right
     73:      or symmetrically around the operator.

     75:    Level: beginner

     77: .seealso:
     78: E*/
     79: typedef enum { PC_LEFT,PC_RIGHT,PC_SYMMETRIC } PCSide;

     82: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCreate(MPI_Comm,PC*);
     83: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSetType(PC,PCType);
     84: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSetUp(PC);
     85: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSetUpOnBlocks(PC);
     86: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCApply(PC,Vec,Vec);
     87: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCApplySymmetricLeft(PC,Vec,Vec);
     88: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCApplySymmetricRight(PC,Vec,Vec);
     89: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec);
     90: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCApplyTranspose(PC,Vec,Vec);
     91: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCHasApplyTranspose(PC,PetscTruth*);
     92: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCApplyBAorABTranspose(PC,PCSide,Vec,Vec,Vec);
     93: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCApplyRichardson(PC,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal,PetscInt);
     94: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCApplyRichardsonExists(PC,PetscTruth*);

     96: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCRegisterDestroy(void);
     97: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCRegisterAll(const char[]);

    100: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCRegister(const char[],const char[],const char[],PetscErrorCode(*)(PC));

    102: /*MC
    103:    PCRegisterDynamic - Adds a method to the preconditioner package.

    105:    Synopsis:
    106:    PetscErrorCode PCRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(PC))

    108:    Not collective

    110:    Input Parameters:
    111: +  name_solver - name of a new user-defined solver
    112: .  path - path (either absolute or relative) the library containing this solver
    113: .  name_create - name of routine to create method context
    114: -  routine_create - routine to create method context

    116:    Notes:
    117:    PCRegisterDynamic() may be called multiple times to add several user-defined preconditioners.

    119:    If dynamic libraries are used, then the fourth input argument (routine_create)
    120:    is ignored.

    122:    Sample usage:
    123: .vb
    124:    PCRegisterDynamic("my_solver","/home/username/my_lib/lib/libO/solaris/mylib",
    125:               "MySolverCreate",MySolverCreate);
    126: .ve

    128:    Then, your solver can be chosen with the procedural interface via
    129: $     PCSetType(pc,"my_solver")
    130:    or at runtime via the option
    131: $     -pc_type my_solver

    133:    Level: advanced

    135:    Notes: ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR},  or ${any environmental variable}
    136:            occuring in pathname will be replaced with appropriate values.
    137:          If your function is not being put into a shared library then use PCRegister() instead

    139: .keywords: PC, register

    141: .seealso: PCRegisterAll(), PCRegisterDestroy()
    142: M*/
    143: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
    144: #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,0)
    145: #else
    146: #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,d)
    147: #endif

    149: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCDestroy(PC);
    150: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSetFromOptions(PC);
    151: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCGetType(PC,PCType*);

    153: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCGetFactoredMatrix(PC,Mat*);
    154: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSetModifySubMatrices(PC,PetscErrorCode(*)(PC,PetscInt,const IS[],const IS[],Mat[],void*),void*);
    155: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCModifySubMatrices(PC,PetscInt,const IS[],const IS[],Mat[],void*);

    157: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSetOperators(PC,Mat,Mat,MatStructure);
    158: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCGetOperators(PC,Mat*,Mat*,MatStructure*);

    160: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCView(PC,PetscViewer);

    162: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSetOptionsPrefix(PC,const char[]);
    163: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCAppendOptionsPrefix(PC,const char[]);
    164: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCGetOptionsPrefix(PC,const char*[]);

    166: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCComputeExplicitOperator(PC,Mat*);

    168: /*
    169:       These are used to provide extra scaling of preconditioned
    170:    operator for time-stepping schemes like in PVODE
    171: */
    172: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCDiagonalScale(PC,PetscTruth*);
    173: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCDiagonalScaleLeft(PC,Vec,Vec);
    174: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCDiagonalScaleRight(PC,Vec,Vec);
    175: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCDiagonalScaleSet(PC,Vec);

    177: /* ------------- options specific to particular preconditioners --------- */

    179: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCJacobiSetUseRowMax(PC);
    180: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSORSetSymmetric(PC,MatSORType);
    181: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSORSetOmega(PC,PetscReal);
    182: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSORSetIterations(PC,PetscInt,PetscInt);

    184: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCEisenstatSetOmega(PC,PetscReal);
    185: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCEisenstatNoDiagonalScaling(PC);

    187: #define USE_PRECONDITIONER_MATRIX 0
    188: #define USE_TRUE_MATRIX           1
    189: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCBJacobiSetUseTrueLocal(PC);
    190: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCBJacobiSetTotalBlocks(PC,PetscInt,const PetscInt[]);
    191: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCBJacobiSetLocalBlocks(PC,PetscInt,const PetscInt[]);

    193: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCKSPSetUseTrue(PC);

    195: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCShellSetApply(PC,PetscErrorCode (*)(void*,Vec,Vec));
    196: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCShellSetApplyTranspose(PC,PetscErrorCode (*)(void*,Vec,Vec));
    197: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCShellSetSetUp(PC,PetscErrorCode (*)(void*));
    198: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCShellSetApplyRichardson(PC,PetscErrorCode (*)(void*,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal,PetscInt));
    199: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCShellSetView(PC,PetscErrorCode (*)(void*,PetscViewer));
    200: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCShellSetDestroy(PC,PetscErrorCode (*)(void*));
    201: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCShellGetContext(PC,void**);
    202: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCShellSetContext(PC,void*);
    203: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCShellSetName(PC,const char[]);
    204: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCShellGetName(PC,char*[]);

    206: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCFactorSetZeroPivot(PC,PetscReal);
    207: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCFactorSetShiftNonzero(PC,PetscReal);
    208: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCFactorSetShiftPd(PC,PetscTruth);

    210: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCLUSetMatOrdering(PC,MatOrderingType);
    211: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCLUSetReuseOrdering(PC,PetscTruth);
    212: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCLUSetReuseFill(PC,PetscTruth);
    213: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCLUSetUseInPlace(PC);
    214: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCLUSetFill(PC,PetscReal);
    215: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCLUSetPivoting(PC,PetscReal);
    216: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCLUSetPivotInBlocks(PC,PetscTruth);
    217: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCLUReorderForNonzeroDiagonal(PC,PetscReal);

    219: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCholeskySetMatOrdering(PC,MatOrderingType);
    220: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCholeskySetReuseOrdering(PC,PetscTruth);
    221: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCholeskySetReuseFill(PC,PetscTruth);
    222: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCholeskySetUseInPlace(PC);
    223: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCholeskySetFill(PC,PetscReal);
    224: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCholeskySetPivotInBlocks(PC,PetscTruth);

    226: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCILUSetMatOrdering(PC,MatOrderingType);
    227: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCILUSetUseInPlace(PC);
    228: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCILUSetFill(PC,PetscReal);
    229: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCILUSetLevels(PC,PetscInt);
    230: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCILUSetReuseOrdering(PC,PetscTruth);
    231: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCILUSetUseDropTolerance(PC,PetscReal,PetscReal,PetscInt);
    232: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCILUDTSetReuseFill(PC,PetscTruth);
    233: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCILUSetAllowDiagonalFill(PC);
    234: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCILUSetPivotInBlocks(PC,PetscTruth);
    235: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCILUReorderForNonzeroDiagonal(PC,PetscReal);

    237: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCICCSetMatOrdering(PC,MatOrderingType);
    238: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCICCSetFill(PC,PetscReal);
    239: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCICCSetLevels(PC,PetscInt);
    240: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCICCSetPivotInBlocks(PC,PetscTruth);

    242: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCASMSetLocalSubdomains(PC,PetscInt,IS[]);
    243: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCASMSetTotalSubdomains(PC,PetscInt,IS[]);
    244: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCASMSetOverlap(PC,PetscInt);
    245: /*E
    246:     PCASMType - Type of additive Schwarz method to use

    248: $  PC_ASM_BASIC - symmetric version where residuals from the ghost points are used
    249: $                 and computed values in ghost regions are added together. Classical
    250: $                 standard additive Schwarz
    251: $  PC_ASM_RESTRICT - residuals from ghost points are used but computed values in ghost
    252: $                    region are discarded. Default
    253: $  PC_ASM_INTERPOLATE - residuals from ghost points are not used, computed values in ghost
    254: $                       region are added back in
    255: $  PC_ASM_NONE - ghost point residuals are not used, computed ghost values are discarded
    256: $                not very good.

    258:    Level: beginner

    260: .seealso: PCASMSetType()
    261: E*/
    262: typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType;

    265: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCASMSetType(PC,PCASMType);
    266: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCASMCreateSubdomains2D(PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt *,IS **);
    267: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCASMSetUseInPlace(PC);
    268: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCASMGetLocalSubdomains(PC,PetscInt*,IS*[]);
    269: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCASMGetLocalSubmatrices(PC,PetscInt*,Mat*[]);

    271: /*E
    272:     PCCompositeType - Determines how two or more preconditioner are composed

    274: $  PC_COMPOSITE_ADDITIVE - results from application of all preconditioners are added together
    275: $  PC_COMPOSITE_MULTIPLICATIVE - preconditioners are applied sequentially to the residual freshly
    276: $                                computed after the previous preconditioner application
    277: $  PC_COMPOSITE_SPECIAL - This is very special for a matrix of the form alpha I + R + S
    278: $                         where first preconditioner is built from alpha I + S and second from
    279: $                         alpha I + R

    281:    Level: beginner

    283: .seealso: PCCompositeSetType()
    284: E*/
    285: typedef enum {PC_COMPOSITE_ADDITIVE,PC_COMPOSITE_MULTIPLICATIVE,PC_COMPOSITE_SPECIAL} PCCompositeType;

    288: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCompositeSetUseTrue(PC);
    289: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCompositeSetType(PC,PCCompositeType);
    290: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCompositeAddPC(PC,PCType);
    291: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCompositeGetPC(PC pc,PetscInt n,PC *);
    292: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCCompositeSpecialSetAlpha(PC,PetscScalar);

    294: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCRedundantSetScatter(PC,VecScatter,VecScatter);
    295: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCRedundantGetOperators(PC,Mat*,Mat*);
    296: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCRedundantGetPC(PC,PC*);

    298: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSPAISetEpsilon(PC,double);
    299: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSPAISetNBSteps(PC,PetscInt);
    300: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSPAISetMax(PC,PetscInt);
    301: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSPAISetMaxNew(PC,PetscInt);
    302: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSPAISetBlockSize(PC,PetscInt);
    303: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSPAISetCacheSize(PC,PetscInt);
    304: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSPAISetVerbose(PC,PetscInt);
    305: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCSPAISetSp(PC,PetscInt);

    307: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCHYPRESetType(PC,const char[]);
    308: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCBJacobiGetLocalBlocks(PC,PetscInt*,const PetscInt*[]);
    309: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCBJacobiGetTotalBlocks(PC,PetscInt*,const PetscInt*[]);

    311: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCFieldSplitSetFields(PC,PetscInt,PetscInt*);
    312: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCFieldSplitSetType(PC,PCCompositeType);

    314: EXTERN PetscErrorCode PETSCKSP_DLLEXPORT PCPrometheusSetCoordinates(PC,PetscReal*);

    317: #endif /* __PETSCPC_H */