1 |
<TITLE>/</TITLE> |
---|
2 |
<BODY> |
---|
3 |
<A HREF = "index.html">[Index for ./FEM]</A> |
---|
4 |
<A HREF = "../index.html">[Return to Master Index]</A> |
---|
5 |
<H1>loadgrid</H1> |
---|
6 |
<H2>(./FEM/loadgrid.m)</H2> |
---|
7 |
<HR><H3>Function Synopsis</H3> |
---|
8 |
<pre>fem_grid_struct=loadgrid(gridname)</pre> |
---|
9 |
<HR><H3>Help text</H3> |
---|
10 |
<pre> |
---|
11 |
LOADGRID load principle gridfiles for a given FEM domain |
---|
12 |
LOADGRID loads grid files for a given FEM domain and returns |
---|
13 |
a <A HREF = "../3.FEM/fem_grid_struct.html">fem_grid_struct</A> to the local workspace. The returned |
---|
14 |
structure contains atleast the minimum grid components |
---|
15 |
for boundary plotting, contouring, etc. Additionally, |
---|
16 |
if land description files exist (.lnd, .lbe), the land |
---|
17 |
description arrays are attached to the structure as well. |
---|
18 |
|
---|
19 |
Input: gridname - name of domain to load grid files |
---|
20 |
|
---|
21 |
Output: LOADGRID returns a <A HREF = "../3.FEM/fem_grid_struct.html">fem_grid_struct</A> containing (atleast) |
---|
22 |
the following fields: |
---|
23 |
1) .name name of FEM domain |
---|
24 |
2) .e node connectivity array (cols 2-4 of .ele file ) |
---|
25 |
3) .x x-horizontal node list (col 2 of .nod file ) |
---|
26 |
4) .y y-horizontal node list (col 3 of .nod file ) |
---|
27 |
5) .z bathymetry list (col 2 of .bat) file |
---|
28 |
6) .bnd boundary node/pair list (.bnd file ) |
---|
29 |
|
---|
30 |
LOADGRID with no input gridname checks to see if the global |
---|
31 |
variable DOMAIN has been set. If so, LOADGRID uses this |
---|
32 |
name to load files for. If DOMAIN does NOT exist or is |
---|
33 |
empty, the input gridname must be specified. |
---|
34 |
|
---|
35 |
If the boundary list (.bnd) exists locally, LOADGRID |
---|
36 |
attempts to load the remaining files locally. If the .bnd |
---|
37 |
file does NOT exist locally, LOADGRID searches the |
---|
38 |
GRIDS and GRIDDIRS global variables for the grid data. |
---|
39 |
|
---|
40 |
If any of the principle grids files does not exist, LOADGRID |
---|
41 |
displays the appropriate message and exits, returning a |
---|
42 |
partially filled <A HREF = "../3.FEM/fem_grid_struct.html">fem_grid_struct</A> WHICH IS INVALID. The |
---|
43 |
returned structure CANNOT be passed to any subsequent |
---|
44 |
OPNML/MATLAB function expecting a valid <A HREF = "../3.FEM/fem_grid_struct.html">fem_grid_struct</A>. |
---|
45 |
NOTE THIS EXCEPTION: the function <A HREF = "../3.FEM/gridinfo.html">GRIDINFO</A> will take any |
---|
46 |
<A HREF = "../3.FEM/fem_grid_struct.html">fem_grid_struct</A> and describe the field contents. |
---|
47 |
|
---|
48 |
EXAMPLE CALL: |
---|
49 |
>> mcbo=loadgrid('mcbo') |
---|
50 |
|
---|
51 |
This returns a <A HREF = "../3.FEM/fem_grid_struct.html">fem_grid_struct</A> into the local workspace |
---|
52 |
named "mcbo" which contains the following minimum fields: |
---|
53 |
|
---|
54 |
mcbo = |
---|
55 |
name: 'mcbo' |
---|
56 |
e: [727x3 double] |
---|
57 |
x: [444x1 double] |
---|
58 |
y: [444x1 double] |
---|
59 |
z: [444x1 double] |
---|
60 |
bnd: [161x2 double] |
---|
61 |
|
---|
62 |
Written by : Brian O. Blanton |
---|
63 |
Summer 1997 |
---|
64 |
|
---|
65 |
</pre> |
---|
66 |
<HR><H3>Cross-Reference Information</H3>This function calls |
---|
67 |
<pre><UL> |
---|
68 |
<LI><A HREF = "../3.FEM/detbndy.html">detbndy</A> ./FEM/detbndy.m</LI> |
---|
69 |
<LI><A HREF = "../3.FEM/el_areas.html">el_areas</A> ./FEM/el_areas.m</LI> |
---|
70 |
</UL></pre> |
---|
71 |
<HR> |
---|
72 |
Produced by <A HREF="http://www.nd.edu/Courses/kantor/matlab/mat2html">mat2html</A> on Tue Feb 2 16:15:45 EST 1999 |
---|
73 |
<BR> |
---|
74 |
Cross-Directory links are: OFF<BR> |
---|
75 |
</BODY> |
---|