/usr/lib/petscdir/3.7.7/x86_64-linux-gnu-complex/include/petsc/private/dmimpl.h is in libpetsc-complex-3.7.7-dev 3.7.7+dfsg1-2build5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 | #if !defined(_DMIMPL_H)
#define _DMIMPL_H
#include <petscdm.h>
#include <petsc/private/petscimpl.h>
PETSC_EXTERN PetscBool DMRegisterAllCalled;
PETSC_EXTERN PetscErrorCode DMRegisterAll(void);
typedef PetscErrorCode (*NullSpaceFunc)(DM dm, PetscInt field, MatNullSpace *nullSpace);
typedef struct _DMOps *DMOps;
struct _DMOps {
PetscErrorCode (*view)(DM,PetscViewer);
PetscErrorCode (*load)(DM,PetscViewer);
PetscErrorCode (*clone)(DM,DM*);
PetscErrorCode (*setfromoptions)(PetscOptionItems*,DM);
PetscErrorCode (*setup)(DM);
PetscErrorCode (*createdefaultsection)(DM);
PetscErrorCode (*createdefaultconstraints)(DM);
PetscErrorCode (*createglobalvector)(DM,Vec*);
PetscErrorCode (*createlocalvector)(DM,Vec*);
PetscErrorCode (*getlocaltoglobalmapping)(DM);
PetscErrorCode (*createfieldis)(DM,PetscInt*,char***,IS**);
PetscErrorCode (*createcoordinatedm)(DM,DM*);
PetscErrorCode (*getcoloring)(DM,ISColoringType,ISColoring*);
PetscErrorCode (*creatematrix)(DM, Mat*);
PetscErrorCode (*createinterpolation)(DM,DM,Mat*,Vec*);
PetscErrorCode (*createrestriction)(DM,DM,Mat*);
PetscErrorCode (*getaggregates)(DM,DM,Mat*);
PetscErrorCode (*getinjection)(DM,DM,Mat*);
PetscErrorCode (*refine)(DM,MPI_Comm,DM*);
PetscErrorCode (*coarsen)(DM,MPI_Comm,DM*);
PetscErrorCode (*refinehierarchy)(DM,PetscInt,DM*);
PetscErrorCode (*coarsenhierarchy)(DM,PetscInt,DM*);
PetscErrorCode (*globaltolocalbegin)(DM,Vec,InsertMode,Vec);
PetscErrorCode (*globaltolocalend)(DM,Vec,InsertMode,Vec);
PetscErrorCode (*localtoglobalbegin)(DM,Vec,InsertMode,Vec);
PetscErrorCode (*localtoglobalend)(DM,Vec,InsertMode,Vec);
PetscErrorCode (*localtolocalbegin)(DM,Vec,InsertMode,Vec);
PetscErrorCode (*localtolocalend)(DM,Vec,InsertMode,Vec);
PetscErrorCode (*destroy)(DM);
PetscErrorCode (*computevariablebounds)(DM,Vec,Vec);
PetscErrorCode (*createsubdm)(DM,PetscInt,PetscInt*,IS*,DM*);
PetscErrorCode (*createfielddecomposition)(DM,PetscInt*,char***,IS**,DM**);
PetscErrorCode (*createdomaindecomposition)(DM,PetscInt*,char***,IS**,IS**,DM**);
PetscErrorCode (*createddscatters)(DM,PetscInt,DM*,VecScatter**,VecScatter**,VecScatter**);
PetscErrorCode (*getdimpoints)(DM,PetscInt,PetscInt*,PetscInt*);
PetscErrorCode (*locatepoints)(DM,Vec,PetscSF);
PetscErrorCode (*projectfunctionlocal)(DM,PetscReal,PetscErrorCode(**)(PetscInt,PetscReal,const PetscReal[],PetscInt,PetscScalar *,void *),void **,InsertMode,Vec);
PetscErrorCode (*projectfunctionlabellocal)(DM,PetscReal,DMLabel,PetscInt,const PetscInt[],PetscErrorCode(**)(PetscInt,PetscReal,const PetscReal[],PetscInt,PetscScalar *,void *),void **,InsertMode,Vec);
PetscErrorCode (*projectfieldlocal)(DM,Vec,void(**)(PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],const PetscScalar[],const PetscScalar[],const PetscInt[],const PetscInt[],const PetscScalar[],const PetscScalar[],const PetscScalar[],PetscReal,const PetscReal[],PetscScalar[]),InsertMode,Vec);
PetscErrorCode (*computel2diff)(DM,PetscReal,PetscErrorCode(**)(PetscInt, PetscReal,const PetscReal [], PetscInt, PetscScalar *, void *), void **, Vec, PetscReal *);
PetscErrorCode (*computel2gradientdiff)(DM,PetscReal,PetscErrorCode(**)(PetscInt,PetscReal,const PetscReal [],const PetscReal[],PetscInt, PetscScalar *,void *),void **,Vec,const PetscReal[],PetscReal *);
PetscErrorCode (*computel2fielddiff)(DM,PetscReal,PetscErrorCode(**)(PetscInt, PetscReal,const PetscReal [], PetscInt, PetscScalar *, void *), void **, Vec, PetscReal *);
};
PETSC_EXTERN PetscErrorCode DMLocalizeCoordinate_Internal(DM, PetscInt, const PetscScalar[], const PetscScalar[], PetscScalar[]);
PETSC_EXTERN PetscErrorCode DMLocalizeCoordinateReal_Internal(DM, PetscInt, const PetscReal[], const PetscReal[], PetscReal[]);
PETSC_EXTERN PetscErrorCode DMLocalizeAddCoordinate_Internal(DM, PetscInt, const PetscScalar[], const PetscScalar[], PetscScalar[]);
typedef struct _DMCoarsenHookLink *DMCoarsenHookLink;
struct _DMCoarsenHookLink {
PetscErrorCode (*coarsenhook)(DM,DM,void*); /* Run once, when coarse DM is created */
PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*); /* Run each time a new problem is restricted to a coarse grid */
void *ctx;
DMCoarsenHookLink next;
};
typedef struct _DMRefineHookLink *DMRefineHookLink;
struct _DMRefineHookLink {
PetscErrorCode (*refinehook)(DM,DM,void*); /* Run once, when a fine DM is created */
PetscErrorCode (*interphook)(DM,Mat,DM,void*); /* Run each time a new problem is interpolated to a fine grid */
void *ctx;
DMRefineHookLink next;
};
typedef struct _DMSubDomainHookLink *DMSubDomainHookLink;
struct _DMSubDomainHookLink {
PetscErrorCode (*ddhook)(DM,DM,void*);
PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*);
void *ctx;
DMSubDomainHookLink next;
};
typedef struct _DMGlobalToLocalHookLink *DMGlobalToLocalHookLink;
struct _DMGlobalToLocalHookLink {
PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*);
PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*);
void *ctx;
DMGlobalToLocalHookLink next;
};
typedef struct _DMLocalToGlobalHookLink *DMLocalToGlobalHookLink;
struct _DMLocalToGlobalHookLink {
PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*);
PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*);
void *ctx;
DMLocalToGlobalHookLink next;
};
typedef enum {DMVEC_STATUS_IN,DMVEC_STATUS_OUT} DMVecStatus;
typedef struct _DMNamedVecLink *DMNamedVecLink;
struct _DMNamedVecLink {
Vec X;
char *name;
DMVecStatus status;
DMNamedVecLink next;
};
typedef struct _DMWorkLink *DMWorkLink;
struct _DMWorkLink {
size_t bytes;
void *mem;
DMWorkLink next;
};
#define DM_MAX_WORK_VECTORS 100 /* work vectors available to users via DMGetGlobalVector(), DMGetLocalVector() */
struct _n_DMLabelLink {
DMLabel label;
PetscBool output;
struct _n_DMLabelLink *next;
};
typedef struct _n_DMLabelLink *DMLabelLink;
struct _n_DMLabelLinkList {
PetscInt refct;
DMLabelLink next;
};
typedef struct _n_DMLabelLinkList *DMLabelLinkList;
typedef struct _n_Boundary *DMBoundary;
struct _n_Boundary {
const char *name;
const char *labelname;
DMLabel label;
PetscBool essential;
PetscInt field;
PetscInt numcomps;
PetscInt *comps;
void (*func)();
PetscInt numids;
PetscInt *ids;
void *ctx;
DMBoundary next;
};
struct _n_DMBoundaryLinkList {
PetscInt refct;
DMBoundary next;
};
typedef struct _n_DMBoundaryLinkList *DMBoundaryLinkList;
PETSC_EXTERN PetscErrorCode DMDestroyLabelLinkList(DM);
PETSC_EXTERN PetscErrorCode DMBoundaryDestroy(DMBoundaryLinkList*);
PETSC_EXTERN PetscErrorCode DMBoundaryDuplicate(DMBoundaryLinkList,DMBoundaryLinkList*);
struct _p_DM {
PETSCHEADER(struct _DMOps);
Vec localin[DM_MAX_WORK_VECTORS],localout[DM_MAX_WORK_VECTORS];
Vec globalin[DM_MAX_WORK_VECTORS],globalout[DM_MAX_WORK_VECTORS];
DMNamedVecLink namedglobal;
DMNamedVecLink namedlocal;
DMWorkLink workin,workout;
DMLabelLinkList labels; /* Linked list of labels */
DMLabel depthLabel; /* Optimized access to depth label */
void *ctx; /* a user context */
PetscErrorCode (*ctxdestroy)(void**);
Vec x; /* location at which the functions/Jacobian are computed */
ISColoringType coloringtype;
MatFDColoring fd;
VecType vectype; /* type of vector created with DMCreateLocalVector() and DMCreateGlobalVector() */
MatType mattype; /* type of matrix created with DMCreateMatrix() */
PetscInt bs;
ISLocalToGlobalMapping ltogmap;
PetscBool prealloc_only; /* Flag indicating the DMCreateMatrix() should only preallocate, not fill the matrix */
PetscInt levelup,leveldown; /* if the DM has been obtained by refining (or coarsening) this indicates how many times that process has been used to generate this DM */
PetscBool setupcalled; /* Indicates that the DM has been set up, methods that modify a DM such that a fresh setup is required should reset this flag */
void *data;
/* Hierarchy / Submeshes */
DM coarseMesh;
DM fineMesh;
DMCoarsenHookLink coarsenhook; /* For transfering auxiliary problem data to coarser grids */
DMRefineHookLink refinehook;
DMSubDomainHookLink subdomainhook;
DMGlobalToLocalHookLink gtolhook;
DMLocalToGlobalHookLink ltoghook;
/* Topology */
PetscInt dim; /* The topological dimension */
/* Flexible communication */
PetscSF sf; /* SF for parallel point overlap */
PetscSF defaultSF; /* SF for parallel dof overlap using default section */
PetscSF sfNatural; /* SF mapping to the "natural" ordering */
PetscBool useNatural; /* Create the natural SF */
/* Allows a non-standard data layout */
PetscSection defaultSection; /* Layout for local vectors */
PetscSection defaultGlobalSection; /* Layout for global vectors */
PetscLayout map;
/* Constraints */
PetscSection defaultConstraintSection;
Mat defaultConstraintMat;
/* Coordinates */
PetscInt dimEmbed; /* The dimension of the embedding space */
DM coordinateDM; /* Layout for coordinates (default section) */
Vec coordinates; /* Coordinate values in global vector */
Vec coordinatesLocal; /* Coordinate values in local vector */
PetscReal *L, *maxCell; /* Size of periodic box and max cell size for determining periodicity */
DMBoundaryType *bdtype; /* Indicates type of topological boundary */
/* Null spaces -- of course I should make this have a variable number of fields */
/* I now believe this might not be the right way: see below */
NullSpaceFunc nullspaceConstructors[10];
/* Fields are represented by objects */
PetscDS prob;
DMBoundaryLinkList boundary; /* List of boundary conditions */
/* Output structures */
DM dmBC; /* The DM with boundary conditions in the global DM */
PetscInt outputSequenceNum; /* The current sequence number for output */
PetscReal outputSequenceVal; /* The current sequence value for output */
PetscObject dmksp,dmsnes,dmts;
};
PETSC_EXTERN PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocatePoints, DM_Coarsen, DM_CreateInterpolation, DM_CreateRestriction;
PETSC_EXTERN PetscErrorCode DMCreateGlobalVector_Section_Private(DM,Vec*);
PETSC_EXTERN PetscErrorCode DMCreateLocalVector_Section_Private(DM,Vec*);
PETSC_EXTERN PetscErrorCode DMCreateSubDM_Section_Private(DM,PetscInt,PetscInt[],IS*,DM*);
/*
Composite Vectors
Single global representation
Individual global representations
Single local representation
Individual local representations
Subsets of individual as a single????? Do we handle this by having DMComposite inside composite??????
DM da_u, da_v, da_p
DM dm_velocities
DM dm
DMDACreate(,&da_u);
DMDACreate(,&da_v);
DMCompositeCreate(,&dm_velocities);
DMCompositeAddDM(dm_velocities,(DM)du);
DMCompositeAddDM(dm_velocities,(DM)dv);
DMDACreate(,&da_p);
DMCompositeCreate(,&dm_velocities);
DMCompositeAddDM(dm,(DM)dm_velocities);
DMCompositeAddDM(dm,(DM)dm_p);
Access parts of composite vectors (Composite only)
---------------------------------
DMCompositeGetAccess - access the global vector as subvectors and array (for redundant arrays)
ADD for local vector -
Element access
--------------
From global vectors
-DAVecGetArray - for DMDA
-VecGetArray - for DMSliced
ADD for DMComposite??? maybe
From individual vector
-DAVecGetArray - for DMDA
-VecGetArray -for sliced
ADD for DMComposite??? maybe
From single local vector
ADD * single local vector as arrays?
Communication
-------------
DMGlobalToLocal - global vector to single local vector
DMCompositeScatter/Gather - direct to individual local vectors and arrays CHANGE name closer to GlobalToLocal?
Obtaining vectors
-----------------
DMCreateGlobal/Local
DMGetGlobal/Local
DMCompositeGetLocalVectors - gives individual local work vectors and arrays
????? individual global vectors ????
*/
#if defined(PETSC_HAVE_HDF5)
PETSC_EXTERN PetscErrorCode DMSequenceLoad_HDF5(DM, const char *, PetscInt, PetscScalar *, PetscViewer);
#endif
#endif
|