Actual source code: slepcrg.h

slepc-3.13.4 2020-09-02
Report Typos and Errors
  1: /*
  2:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  3:    SLEPc - Scalable Library for Eigenvalue Problem Computations
  4:    Copyright (c) 2002-2020, Universitat Politecnica de Valencia, Spain

  6:    This file is part of SLEPc.
  7:    SLEPc is distributed under a 2-clause BSD license (see LICENSE).
  8:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  9: */
 10: /*
 11:    User interface for the region object in SLEPc
 12: */

 14: #if !defined(SLEPCRG_H)
 15: #define SLEPCRG_H
 16:  #include <slepcsys.h>
 17:  #include <slepcrgtypes.h>

 19: SLEPC_EXTERN PetscErrorCode RGInitializePackage(void);

 21: /*J
 22:    RGType - String with the name of the region.

 24:    Level: beginner

 26: .seealso: RGSetType(), RG
 27: J*/
 28: typedef const char* RGType;
 29: #define RGINTERVAL  "interval"
 30: #define RGPOLYGON   "polygon"
 31: #define RGELLIPSE   "ellipse"
 32: #define RGRING      "ring"

 34: /* Logging support */
 35: SLEPC_EXTERN PetscClassId RG_CLASSID;

 37: SLEPC_EXTERN PetscErrorCode RGCreate(MPI_Comm,RG*);
 38: SLEPC_EXTERN PetscErrorCode RGSetType(RG,RGType);
 39: SLEPC_EXTERN PetscErrorCode RGGetType(RG,RGType*);
 40: SLEPC_EXTERN PetscErrorCode RGSetOptionsPrefix(RG,const char *);
 41: SLEPC_EXTERN PetscErrorCode RGAppendOptionsPrefix(RG,const char *);
 42: SLEPC_EXTERN PetscErrorCode RGGetOptionsPrefix(RG,const char *[]);
 43: SLEPC_EXTERN PetscErrorCode RGSetFromOptions(RG);
 44: SLEPC_EXTERN PetscErrorCode RGView(RG,PetscViewer);
 45: SLEPC_EXTERN PetscErrorCode RGViewFromOptions(RG,PetscObject,const char[]);
 46: SLEPC_EXTERN PetscErrorCode RGDestroy(RG*);

 48: SLEPC_EXTERN PetscErrorCode RGIsTrivial(RG,PetscBool*);
 49: SLEPC_EXTERN PetscErrorCode RGSetComplement(RG,PetscBool);
 50: SLEPC_EXTERN PetscErrorCode RGGetComplement(RG,PetscBool*);
 51: SLEPC_EXTERN PetscErrorCode RGSetScale(RG,PetscReal);
 52: SLEPC_EXTERN PetscErrorCode RGGetScale(RG,PetscReal*);
 53: SLEPC_EXTERN PetscErrorCode RGPushScale(RG,PetscReal);
 54: SLEPC_EXTERN PetscErrorCode RGPopScale(RG);
 55: SLEPC_EXTERN PetscErrorCode RGCheckInside(RG,PetscInt,PetscScalar*,PetscScalar*,PetscInt*);
 56: SLEPC_EXTERN PetscErrorCode RGComputeContour(RG,PetscInt,PetscScalar*,PetscScalar*);
 57: SLEPC_EXTERN PetscErrorCode RGComputeBoundingBox(RG,PetscReal*,PetscReal*,PetscReal*,PetscReal*);

 59: SLEPC_EXTERN PetscFunctionList RGList;
 60: SLEPC_EXTERN PetscErrorCode RGRegister(const char[],PetscErrorCode(*)(RG));

 62: /* --------- options specific to particular regions -------- */

 64: SLEPC_EXTERN PetscErrorCode RGEllipseSetParameters(RG,PetscScalar,PetscReal,PetscReal);
 65: SLEPC_EXTERN PetscErrorCode RGEllipseGetParameters(RG,PetscScalar*,PetscReal*,PetscReal*);

 67: SLEPC_EXTERN PetscErrorCode RGIntervalSetEndpoints(RG,PetscReal,PetscReal,PetscReal,PetscReal);
 68: SLEPC_EXTERN PetscErrorCode RGIntervalGetEndpoints(RG,PetscReal*,PetscReal*,PetscReal*,PetscReal*);

 70: SLEPC_EXTERN PetscErrorCode RGPolygonSetVertices(RG,PetscInt,PetscScalar*,PetscScalar*);
 71: SLEPC_EXTERN PetscErrorCode RGPolygonGetVertices(RG,PetscInt*,PetscScalar**,PetscScalar**);

 73: SLEPC_EXTERN PetscErrorCode RGRingSetParameters(RG,PetscScalar,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
 74: SLEPC_EXTERN PetscErrorCode RGRingGetParameters(RG,PetscScalar*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);

 76: #endif