Actual source code: dmgenerate.c
1: #include <petsc/private/dmimpl.h>
3: PETSC_EXTERN PetscErrorCode DMIsForest(DM, PetscBool *);
5: DMGeneratorFunctionList DMGenerateList = NULL;
6: PetscBool DMGenerateRegisterAllCalled = PETSC_FALSE;
8: #if defined(PETSC_HAVE_TRIANGLE)
9: PETSC_EXTERN PetscErrorCode DMPlexGenerate_Triangle(DM, PetscBool, DM *);
10: PETSC_EXTERN PetscErrorCode DMPlexRefine_Triangle(DM, double *, DM *);
11: #endif
12: #if defined(PETSC_HAVE_TETGEN)
13: PETSC_EXTERN PetscErrorCode DMPlexGenerate_Tetgen(DM, PetscBool, DM *);
14: PETSC_EXTERN PetscErrorCode DMPlexRefine_Tetgen(DM, double *, DM *);
15: #endif
16: #if defined(PETSC_HAVE_CTETGEN)
17: PETSC_EXTERN PetscErrorCode DMPlexGenerate_CTetgen(DM, PetscBool, DM *);
18: PETSC_EXTERN PetscErrorCode DMPlexRefine_CTetgen(DM, double *, DM *);
19: #endif
20: #if defined(PETSC_HAVE_PRAGMATIC)
21: PETSC_EXTERN PetscErrorCode DMAdaptMetric_Pragmatic_Plex(DM, Vec, DMLabel, DMLabel, DM *);
22: #endif
23: #if defined(PETSC_HAVE_MMG)
24: PETSC_EXTERN PetscErrorCode DMAdaptMetric_Mmg_Plex(DM, Vec, DMLabel, DMLabel, DM *);
25: #endif
26: #if defined(PETSC_HAVE_PARMMG)
27: PETSC_EXTERN PetscErrorCode DMAdaptMetric_ParMmg_Plex(DM, Vec, DMLabel, DMLabel, DM *);
28: #endif
29: PETSC_EXTERN PetscErrorCode DMPlexTransformAdaptLabel(DM, Vec, DMLabel, DMLabel, DM *);
30: PETSC_EXTERN PetscErrorCode DMAdaptLabel_Forest(DM, Vec, DMLabel, DMLabel, DM *);
32: /*@C
33: DMGenerateRegisterAll - Registers all of the mesh generation methods in the `DM` package.
35: Not Collective
37: Level: advanced
39: .seealso: `DM`, `DMGenerateRegisterDestroy()`
40: @*/
41: PetscErrorCode DMGenerateRegisterAll(void)
42: {
43: PetscFunctionBegin;
44: if (DMGenerateRegisterAllCalled) PetscFunctionReturn(PETSC_SUCCESS);
45: DMGenerateRegisterAllCalled = PETSC_TRUE;
46: #if defined(PETSC_HAVE_TRIANGLE)
47: PetscCall(DMGenerateRegister("triangle", DMPlexGenerate_Triangle, DMPlexRefine_Triangle, NULL, 1));
48: #endif
49: #if defined(PETSC_HAVE_CTETGEN)
50: PetscCall(DMGenerateRegister("ctetgen", DMPlexGenerate_CTetgen, DMPlexRefine_CTetgen, NULL, 2));
51: #endif
52: #if defined(PETSC_HAVE_TETGEN)
53: PetscCall(DMGenerateRegister("tetgen", DMPlexGenerate_Tetgen, DMPlexRefine_Tetgen, NULL, 2));
54: #endif
55: #if defined(PETSC_HAVE_PRAGMATIC)
56: PetscCall(DMGenerateRegister("pragmatic", NULL, NULL, DMAdaptMetric_Pragmatic_Plex, -1));
57: #endif
58: #if defined(PETSC_HAVE_MMG)
59: PetscCall(DMGenerateRegister("mmg", NULL, NULL, DMAdaptMetric_Mmg_Plex, -1));
60: #endif
61: #if defined(PETSC_HAVE_PARMMG)
62: PetscCall(DMGenerateRegister("parmmg", NULL, NULL, DMAdaptMetric_ParMmg_Plex, -1));
63: #endif
64: PetscCall(DMGenerateRegister("cellrefiner", NULL, NULL, DMPlexTransformAdaptLabel, -1));
65: PetscCall(DMGenerateRegister("forest", NULL, NULL, DMAdaptLabel_Forest, -1));
66: PetscFunctionReturn(PETSC_SUCCESS);
67: }
69: /*@C
70: DMGenerateRegister - Adds a grid generator to `DM`
72: Not Collective, No Fortran Support
74: Input Parameters:
75: + sname - name of a new user-defined grid generator
76: . fnc - generator function
77: . rfnc - refinement function
78: . alfnc - adapt by label function
79: - dim - dimension of boundary of domain
81: Example Usage:
82: .vb
83: DMGenerateRegister("my_generator", MyGeneratorCreate, MyGeneratorRefiner, MyGeneratorAdaptor, dim);
84: .ve
86: Then, your generator can be chosen with the procedural interface via
87: $ DMGenerate(dm, "my_generator",...)
88: or at runtime via the option
89: $ -dm_generator my_generator
91: Level: advanced
93: Note:
94: `DMGenerateRegister()` may be called multiple times to add several user-defined generators
96: .seealso: `DM`, `DMGenerateRegisterAll()`, `DMPlexGenerate()`, `DMGenerateRegisterDestroy()`
97: @*/
98: PetscErrorCode DMGenerateRegister(const char sname[], PetscErrorCode (*fnc)(DM, PetscBool, DM *), PetscErrorCode (*rfnc)(DM, PetscReal *, DM *), PetscErrorCode (*alfnc)(DM, Vec, DMLabel, DMLabel, DM *), PetscInt dim)
99: {
100: DMGeneratorFunctionList entry;
102: PetscFunctionBegin;
103: PetscCall(PetscNew(&entry));
104: PetscCall(PetscStrallocpy(sname, &entry->name));
105: entry->generate = fnc;
106: entry->refine = rfnc;
107: entry->adapt = alfnc;
108: entry->dim = dim;
109: entry->next = NULL;
110: if (!DMGenerateList) DMGenerateList = entry;
111: else {
112: DMGeneratorFunctionList fl = DMGenerateList;
113: while (fl->next) fl = fl->next;
114: fl->next = entry;
115: }
116: PetscFunctionReturn(PETSC_SUCCESS);
117: }
119: extern PetscBool DMGenerateRegisterAllCalled;
121: PetscErrorCode DMGenerateRegisterDestroy(void)
122: {
123: DMGeneratorFunctionList next, fl;
125: PetscFunctionBegin;
126: next = fl = DMGenerateList;
127: while (next) {
128: next = fl ? fl->next : NULL;
129: if (fl) PetscCall(PetscFree(fl->name));
130: PetscCall(PetscFree(fl));
131: fl = next;
132: }
133: DMGenerateList = NULL;
134: DMGenerateRegisterAllCalled = PETSC_FALSE;
135: PetscFunctionReturn(PETSC_SUCCESS);
136: }
138: /*@C
139: DMAdaptLabel - Adapt a `DM` based on a `DMLabel` with values interpreted as coarsening and refining flags. Specific implementations of `DM` maybe have
140: specialized flags, but all implementations should accept flag values `DM_ADAPT_DETERMINE`, `DM_ADAPT_KEEP`, `DM_ADAPT_REFINE`, and,
141: `DM_ADAPT_COARSEN`.
143: Collective
145: Input Parameters:
146: + dm - the pre-adaptation `DM` object
147: - label - label with the flags
149: Output Parameters:
150: . dmAdapt - the adapted `DM` object: may be `NULL` if an adapted `DM` could not be produced.
152: Level: intermediate
154: .seealso: `DM`, `DMAdaptMetric()`, `DMCoarsen()`, `DMRefine()`
155: @*/
156: PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *dmAdapt)
157: {
158: DMGeneratorFunctionList fl;
159: char adaptname[PETSC_MAX_PATH_LEN];
160: const char *name;
161: PetscInt dim;
162: PetscBool flg, isForest, found = PETSC_FALSE;
164: PetscFunctionBegin;
167: PetscAssertPointer(dmAdapt, 3);
168: *dmAdapt = NULL;
169: PetscCall(DMGetDimension(dm, &dim));
170: PetscCall(DMIsForest(dm, &isForest));
171: name = isForest ? "forest" : "cellrefiner";
172: PetscCall(PetscOptionsGetString(((PetscObject)dm)->options, ((PetscObject)dm)->prefix, "-dm_adaptor", adaptname, sizeof(adaptname), &flg));
173: if (flg) name = adaptname;
175: fl = DMGenerateList;
176: while (fl) {
177: PetscCall(PetscStrcmp(fl->name, name, &flg));
178: if (flg) {
179: PetscCall((*fl->adapt)(dm, NULL, label, NULL, dmAdapt));
180: found = PETSC_TRUE;
181: }
182: fl = fl->next;
183: }
184: PetscCheck(found, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Grid adaptor %s not registered; you may need to add --download-%s to your ./configure options", name, name);
185: if (*dmAdapt) {
186: (*dmAdapt)->prealloc_only = dm->prealloc_only; /* maybe this should go .... */
187: PetscCall(PetscFree((*dmAdapt)->vectype));
188: PetscCall(PetscStrallocpy(dm->vectype, (char **)&(*dmAdapt)->vectype));
189: PetscCall(PetscFree((*dmAdapt)->mattype));
190: PetscCall(PetscStrallocpy(dm->mattype, (char **)&(*dmAdapt)->mattype));
191: }
192: PetscFunctionReturn(PETSC_SUCCESS);
193: }
195: /*@C
196: DMAdaptMetric - Generates a mesh adapted to the specified metric field.
198: Input Parameters:
199: + dm - The DM object
200: . metric - The metric to which the mesh is adapted, defined vertex-wise.
201: . bdLabel - Label for boundary tags, which will be preserved in the output mesh. `bdLabel` should be `NULL` if there is no such label, and should be different from "_boundary_".
202: - rgLabel - Label for cell tags, which will be preserved in the output mesh. `rgLabel` should be `NULL` if there is no such label, and should be different from "_regions_".
204: Output Parameter:
205: . dmAdapt - Pointer to the `DM` object containing the adapted mesh
207: Note:
208: The label in the adapted mesh will be registered under the name of the input `DMLabel` object
210: Level: advanced
212: .seealso: `DMAdaptLabel()`, `DMCoarsen()`, `DMRefine()`
213: @*/
214: PetscErrorCode DMAdaptMetric(DM dm, Vec metric, DMLabel bdLabel, DMLabel rgLabel, DM *dmAdapt)
215: {
216: DMGeneratorFunctionList fl;
217: char adaptname[PETSC_MAX_PATH_LEN];
218: const char *name;
219: const char *const adaptors[3] = {"pragmatic", "mmg", "parmmg"};
220: PetscInt dim;
221: PetscBool flg, found = PETSC_FALSE;
223: PetscFunctionBegin;
228: PetscAssertPointer(dmAdapt, 5);
229: *dmAdapt = NULL;
230: PetscCall(DMGetDimension(dm, &dim));
231: PetscCall(PetscOptionsGetString(((PetscObject)dm)->options, ((PetscObject)dm)->prefix, "-dm_adaptor", adaptname, sizeof(adaptname), &flg));
233: /* Default to Mmg in serial and ParMmg in parallel */
234: if (flg) name = adaptname;
235: else {
236: MPI_Comm comm;
237: PetscMPIInt size;
239: PetscCall(PetscObjectGetComm((PetscObject)dm, &comm));
240: PetscCallMPI(MPI_Comm_size(comm, &size));
241: if (size == 1) name = adaptors[1];
242: else name = adaptors[2];
243: }
245: fl = DMGenerateList;
246: while (fl) {
247: PetscCall(PetscStrcmp(fl->name, name, &flg));
248: if (flg) {
249: PetscCall((*fl->adapt)(dm, metric, bdLabel, rgLabel, dmAdapt));
250: found = PETSC_TRUE;
251: }
252: fl = fl->next;
253: }
254: PetscCheck(found, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Grid adaptor %s not registered; you may need to add --download-%s to your ./configure options", name, name);
255: if (*dmAdapt) {
256: (*dmAdapt)->prealloc_only = dm->prealloc_only; /* maybe this should go .... */
257: PetscCall(PetscFree((*dmAdapt)->vectype));
258: PetscCall(PetscStrallocpy(dm->vectype, (char **)&(*dmAdapt)->vectype));
259: PetscCall(PetscFree((*dmAdapt)->mattype));
260: PetscCall(PetscStrallocpy(dm->mattype, (char **)&(*dmAdapt)->mattype));
261: }
262: PetscFunctionReturn(PETSC_SUCCESS);
263: }