NAG Library Routine Document

D06BAF

INTEGER	NLINES, LINED(4,NLINES), SDCRUS, NCOMP, NLCOMP(NCOMP), LCOMP(NLINES), NVMAX, NEDMX, NVB, NEDGE, EDGE(3,NEDMX), ITRACE, IUSER(*), LRWORK, IWORK(LIWORK), LIWORK, IFAIL
REAL (KIND=nag_wp)	COORCH(2,NLINES), FBND, CRUS(2,SDCRUS), RATE(NLINES), COOR(2,NVMAX), RUSER(*), RWORK(LRWORK)
EXTERNAL	FBND

3 Description

Given a closed connected subdomain

Ω

ℝ^{2}

, whose boundary

\partial Ω

is divided by characteristic points into

m

distinct line segments, D06BAF generates a boundary mesh on

\partial Ω

. Each line segment may be a straight line, a curve defined by the equation

f (x, y) = 0

, or a polygonal curve defined by a set of given boundary mesh points.

This routine is primarily designed for use with either D06AAF (a simple incremental method) or D06ABF (Delaunay–Voronoi method) or D06ACF (Advancing Front method) to triangulate the interior of the domain

Ω

. For more details about the boundary and interior mesh generation, consult the D06 Chapter Introduction as well as George and Borouchaki (1998).

This routine is derived from material in the MODULEF package from INRIA (Institut National de Recherche en Informatique et Automatique).

4 References

George P L and Borouchaki H (1998) Delaunay Triangulation and Meshing: Application to Finite Elements Editions HERMES, Paris

5 Parameters

1: $NLINES$ – INTEGERInput

On entry:

m

, the number of lines that define the boundary of the closed connected subdomain (this equals the number of characteristic points which separate the entire boundary

\partial Ω

into lines).

Constraint:

NLINES \geq 1

2: $COORCH (2, NLINES)$ – REAL (KIND=nag_wp) arrayInput

On entry:

COORCH (1, i)

contains the

x

coordinate of the

i

th characteristic point, for

i = 1, 2, \dots, NLINES

; while

COORCH (2, i)

contains the corresponding

y

coordinate.

3: $LINED (4, NLINES)$ – INTEGER arrayInput

On entry: the description of the lines that define the boundary domain. The line

i

, for

i = 1, 2, \dots, m

, is defined as follows:

$LINED (1, i)$

The number of points on the line, including two end points.

$LINED (2, i)$

The first end point of the line. If

LINED (2, i) = j

, then the coordinates of the first end point are those stored in

COORCH (: j)

$LINED (3, i)$

The second end point of the line. If

LINED (3, i) = k

, then the coordinates of the second end point are those stored in

COORCH (: k)

$LINED (4, i)$

This defines the type of line segment connecting the end points. Additional information is conveyed by the numerical value of

LINED (4, i)

as follows:

(i)	$LINED (4, i) > 0$ , the line is described in FBND with $LINED (4, i)$ as the index. In this case, the line must be described in the trigonometric (anticlockwise) direction;
(ii)	$LINED (4, i) = 0$ , the line is a straight line;
(iii)	if $LINED (4, i) < 0$ , say ( $- p$ ), then the line is a polygonal arc joining the end points and interior points specified in CRUS. In this case the line contains the points whose coordinates are stored in $COORCH (: j), CRUS (: p), CRUS (: p + 1), \dots, CRUS (: p + r - 3), COORCH (: k)$ , where $z \in \{1, 2\}$ , $r = LINED (1, i)$ , $j = LINED (2, i)$ and $k = LINED (3, i)$ .

Constraints:

$2 \leq LINED (1, i)$ ;
$1 \leq LINED (2, i) \leq NLINES$ ;
$1 \leq LINED (3, i) \leq NLINES$ ;
$LINED (2, i) \neq LINED (3, i)$ , for $i = 1, 2, \dots, NLINES$ .

For each line described by FBND (lines with

LINED (4, i) > 0

, for

i = 1, 2, \dots, NLINES

) the two end points (

LINED (2, i)

and

LINED (3, i)

) lie on the curve defined by index

LINED (4, i)

in FBND, i.e.,

FBND (LINED (4, i), COORCH (1, LINED (2, i)), COORCH (2, LINED (2, i)), RUSER, IUSER) = 0

;

FBND (LINED (4, i), COORCH (1, LINED (3, i)), COORCH (2, LINED (3, i)), RUSER, IUSER) = 0

, for

i = 1, 2, \dots, NLINES

For all lines described as polygonal arcs (lines with

LINED (4, i) < 0

, for

i = 1, 2, \dots, NLINES

) the sets of intermediate points (i.e.,

[- LINED (4, i) : - LINED (4, i) + LINED (1, i) - 3]

for all

i

such that

LINED (4, i) < 0

) are not overlapping. This can be expressed as:

- LINED (4, i) + LINED (1, i) - 3 = \sum_{\{i, LINED (4, i) < 0\}} \{LINED (1, i) - 2\}

- LINED (4, i) + LINED (1, i) - 2 = - LINED (4, j),

for a

j

such that

j = 1, 2, \dots, NLINES

j \neq i

and

LINED (4, j) < 0

4: $FBND$ – REAL (KIND=nag_wp) FUNCTION, supplied by the user.External Procedure

FBND must be supplied to calculate the value of the function which describes the curve

\{(x, y) \in ℝ^{2}; such that ​ f (x, y) = 0\}

on segments of the boundary for which

LINED (4, i) > 0

. If there are no boundaries for which

LINED (4, i) > 0

FBND will never be referenced by D06BAF and FBND may be the dummy function D06BAD. (D06BAD is included in the NAG Library.)

The specification of FBND is:

FUNCTION FBND (

I, X, Y, RUSER, IUSER)

REAL (KIND=nag_wp) FBND

INTEGER	I, IUSER(*)
REAL (KIND=nag_wp)	X, Y, RUSER(*)

1: $I$ – INTEGERInput: On entry: $LINED (4, i)$ , the reference index of the line (portion of the contour) $i$ described.
2: $X$ – REAL (KIND=nag_wp)Input
3: $Y$ – REAL (KIND=nag_wp)Input: On entry: the values of $x$ and $y$ at which $f (x, y)$ is to be evaluated.
4: $RUSER (*)$ – REAL (KIND=nag_wp) arrayUser Workspace
5: $IUSER (*)$ – INTEGER arrayUser Workspace: FBND is called with the parameters RUSER and IUSER as supplied to D06BAF. You are free to use the arrays RUSER and IUSER to supply information to FBND as an alternative to using COMMON global variables.

FBND must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D06BAF is called. Parameters denoted as Input must not be changed by this procedure.

5: $CRUS (2, SDCRUS)$ – REAL (KIND=nag_wp) arrayInput

On entry: the coordinates of the intermediate points for polygonal arc lines. For a line

i

defined as a polygonal arc (i.e.,

LINED (4, i) < 0

), if

p = - LINED (4, i)

, then

CRUS (1, k)

, for

k = p, \dots, p + LINED (1, i) - 3

, must contain the

x

coordinate of the consecutive intermediate points for this line. Similarly

CRUS (2, k)

, for

k = p, \dots, p + LINED (1, i) - 3

, must contain the corresponding

y

coordinate.

6: $SDCRUS$ – INTEGERInput

On entry: the second dimension of the array CRUS as declared in the (sub)program from which D06BAF is called.

Constraint:

SDCRUS \geq \sum_{\{i, LINED (4, i) < 0\}} \{LINED (1, i) - 2\}

7: $RATE (NLINES)$ – REAL (KIND=nag_wp) arrayInput

On entry:

RATE (i)

is the geometric progression ratio between the points to be generated on the line

i

, for

i = 1, 2, \dots, m

and

LINED (4, i) \geq 0

LINED (4, i) < 0

RATE (i)

is not referenced.

Constraint: if

LINED (4, i) \geq 0

RATE (i) > 0.0

, for

i = 1, 2, \dots, NLINES

8: $NCOMP$ – INTEGERInput

On entry:

n

, the number of separately connected components of the boundary.

Constraint:

NCOMP \geq 1

9: $NLCOMP (NCOMP)$ – INTEGER arrayInput

On entry:

|NLCOMP (k)|

is the number of line segments in component

k

of the contour. The line

i

of component

k

runs in the direction

LINED (2, i)

LINED (3, i)

NLCOMP (k) > 0

, and in the opposite direction otherwise; for

k = 1, 2, \dots, n

Constraints:

$1 \leq |NLCOMP (k)| \leq NLINES$ , for $k = 1, 2, \dots, NCOMP$ ;
$\sum_{k = 1}^{n} |NLCOMP (k)| = NLINES$ .

10: $LCOMP (NLINES)$ – INTEGER arrayInput

On entry: LCOMP must contain the list of line numbers for the each component of the boundary. Specifically, the line numbers for the

k

th component of the boundary, for

k = 1, 2, \dots, NCOMP

, must be in elements

l 1 - 1

l 2 - 1

of LCOMP, where

l 2 = \sum_{i = 1}^{k} |NLCOMP (i)|

and

l 1 = l 2 + 1 - |NLCOMP (k)|

Constraint:

LCOMP

must hold a valid permutation of the integers

[1, NLINES]

11: $NVMAX$ – INTEGERInput

On entry: the maximum number of the boundary mesh vertices to be generated.

Constraint:

NVMAX \geq NLINES

12: $NEDMX$ – INTEGERInput

On entry: the maximum number of boundary edges in the boundary mesh to be generated.

Constraint:

NEDMX \geq 1

13: $NVB$ – INTEGEROutput

On exit: the total number of boundary mesh vertices generated.

14: $COOR (2, NVMAX)$ – REAL (KIND=nag_wp) arrayOutput

On exit:

COOR (1, i)

will contain the

x

coordinate of the

i

th boundary mesh vertex generated, for

i = 1, 2, \dots, NVB

; while

COOR (2, i)

will contain the corresponding

y

coordinate.

15: $NEDGE$ – INTEGEROutput

On exit: the total number of boundary edges in the boundary mesh.

16: $EDGE (3, NEDMX)$ – INTEGER arrayOutput

On exit: the specification of the boundary edges.

EDGE (1, j)

and

EDGE (2, j)

will contain the vertex numbers of the two end points of the

j

th boundary edge.

EDGE (3, j)

is a reference number for the

j

th boundary edge and

$EDGE (3, j) = LINED (4, i)$ , where $i$ and $j$ are such that the $j$ th edges is part of the $i$ th line of the boundary and $LINED (4, i) \geq 0$ ;
$EDGE (3, j) = 100 + |LINED (4, i)|$ , where $i$ and $j$ are such that the $j$ th edges is part of the $i$ th line of the boundary and $LINED (4, i) < 0$ .

17: $ITRACE$ – INTEGERInput

On entry: the level of trace information required from D06BAF.

$ITRACE = 0$ or $ITRACE < - 1$: No output is generated.
$ITRACE = 1$: Output from the boundary mesh generator is printed on the current advisory message unit (see X04ABF). This output contains the input information of each line and each connected component of the boundary.
$ITRACE = - 1$: An analysis of the output boundary mesh is printed on the current advisory message unit. This analysis includes the orientation (clockwise or anticlockwise) of each connected component of the boundary. This information could be of interest to you, especially if an interior meshing is carried out using the output of this routine, calling either D06AAF, D06ABF or D06ACF.
$ITRACE > 1$: The output is similar to that produced when $ITRACE = 1$ , but the coordinates of the generated vertices on the boundary are also output.

You are advised to set

ITRACE = 0

, unless you are experienced with finite element mesh generation.

18: $RUSER (*)$ – REAL (KIND=nag_wp) arrayUser Workspace

19: $IUSER (*)$ – INTEGER arrayUser Workspace

RUSER and IUSER are not used by D06BAF, but are passed directly to FBND and may be used to pass information to this routine as an alternative to using COMMON global variables.

20: $RWORK (LRWORK)$ – REAL (KIND=nag_wp) arrayWorkspace

21: $LRWORK$ – INTEGERInput

On entry: the dimension of the array RWORK as declared in the (sub)program from which D06BAF is called.

Constraint:

LRWORK \geq 2 \times (NLINES + SDCRUS) + 2 \times \max_{i = 1, 2, \dots, m} \{LINED (1, i)\} \times NLINES

22: $IWORK (LIWORK)$ – INTEGER arrayWorkspace

23: $LIWORK$ – INTEGERInput

On entry: the dimension of the array IWORK as declared in the (sub)program from which D06BAF is called.

Constraint:

LIWORK \geq \sum_{\{i, LINED (4, i) < 0\}} \{LINED (1, i) - 2\} + 8 \times NLINES + NVMAX + 3 \times NEDMX + 2 \times SDCRUS

24: $IFAIL$ – INTEGERInput/Output

On entry: IFAIL must be set to

0

- 1 ​ or ​ 1

. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value

- 1 ​ or ​ 1

is recommended. If the output of error messages is undesirable, then the value

1

is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is

0

. When the value $- 1 or 1$ is used it is essential to test the value of IFAIL on exit.

On exit:

IFAIL = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

IFAIL = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by X04AAF).

Errors or warnings detected by the routine:

$IFAIL = 1$

On entry,	$NLINES < 1$ ;
or	$NVMAX < NLINES$ ;
or	$NEDMX < 1$ ;
or	$NCOMP < 1$ ;
or	$LRWORK < 2 \times (NLINES + SDCRUS) + 2 \times \max_{i = 1, 2, \dots, m} \{LINED (1, i)\} \times NLINES$ ;
or	$LIWORK < \sum_{\{i, LINED (4, i) < 0\}} \{LINED (1, i) - 2\} + 8 \times NLINES + NVMAX + 3 \times NEDMX + 2 \times SDCRUS$ ;
or	$SDCRUS < \sum_{\{i, LINED (4, i) < 0\}} \{LINED (1, i) - 2\}$ ;
or	$RATE (i) < 0.0$ for some $i = 1, 2, \dots, NLINES$ with $LINED (4, i) \geq 0$ ;
or	$LINED (1, i) < 2$ for some $i = 1, 2, \dots, NLINES$ ;
or	$LINED (2, i) < 1$ or $LINED (2, i) > NLINES$ for some $i = 1, 2, \dots, NLINES$ ;
or	$LINED (3, i) < 1$ or $LINED (3, i) > NLINES$ for some $i = 1, 2, \dots, NLINES$ ;
or	$LINED (2, i) = LINED (3, i)$ for some $i = 1, 2, \dots, NLINES$ ;
or	$NLCOMP (k) = 0$ , or $\|NLCOMP (k)\| > NLINES$ for a $k = 1, 2, \dots, NCOMP$ ;
or	$\sum_{k = 1}^{n} \|NLCOMP (k)\| \neq NLINES$ ;
or	LCOMP does not represent a valid permutation of the integers in $[1, NLINES]$ ;
or	one of the end points for a line $i$ described by the user-supplied function (lines with $LINED (4, i) > 0$ , for $i = 1, 2, \dots, NLINES$ ) does not belong to the corresponding curve in FBND;
or	the intermediate points for the lines described as polygonal arcs (lines with $LINED (4, i) < 0$ , for $i = 1, 2, \dots, NLINES$ ) are overlapping.

$IFAIL = 2$: An error has occurred during the generation of the boundary mesh. It appears that NEDMX is not large enough, so you are advised to increase the value of NEDMX.

$IFAIL = 3$: An error has occurred during the generation of the boundary mesh. It appears that NVMAX is not large enough, so you are advised to increase the value of NVMAX.

$IFAIL = 4$: An error has occurred during the generation of the boundary mesh. Check the definition of each line (the parameter LINED) and each connected component of the boundary (the arguments NLCOMP, and LCOMP, as well as the coordinates of the characteristic points. Setting $ITRACE > 0$ may provide more details.

$IFAIL = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.

$IFAIL = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.

$IFAIL = - 999$: Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Not applicable.

9 Further Comments

The boundary mesh generation technique in this routine has a ‘tree’ structure. The boundary should be partitioned into geometrically simple segments (straight lines or curves) delimited by characteristic points. Then, the lines should be assembled into connected components of the boundary domain.

Using this strategy, the inputs to that routine can be built up, following the requirements stated in Section 5:

the characteristic and the user-supplied intermediate points:
- NLINES, SDCRUS, COORCH and CRUS;
the characteristic lines:
- LINED, FBND, RATE;
finally the assembly of lines into the connected components of the boundary:
- NCOMP, and
- NLCOMP, LCOMP.

The example below details the use of this strategy.

10 Example

The NAG logo is taken as an example of a geometry with holes. The boundary has been partitioned in

40

lines characteristic points; including

4

for the exterior boundary and

36

for the logo itself. All line geometry specifications have been considered, see the description of LINED, including

4

lines defined as polygonal arc,

4

defined by FBND and all the others are straight lines.

NAG Library Routine DocumentD06BAF

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG Library Routine Document

D06BAF