/[escript]/trunk/dudley/src/CPPAdapter/MeshAdapterFactory.h
ViewVC logotype

Annotation of /trunk/dudley/src/CPPAdapter/MeshAdapterFactory.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2519 - (hide annotations)
Mon Jul 6 00:43:08 2009 UTC (9 years, 9 months ago) by jfenwick
Original Path: trunk/finley/src/CPPAdapter/MeshAdapterFactory.h
File MIME type: text/plain
File size: 7154 byte(s)
Correcting some doxygen errors
1 ksteube 1312
2     /*******************************************************
3 ksteube 1811 *
4     * Copyright (c) 2003-2008 by University of Queensland
5     * Earth Systems Science Computational Center (ESSCC)
6     * http://www.uq.edu.au/esscc
7     *
8     * Primary Business: Queensland, Australia
9     * Licensed under the Open Software License version 3.0
10     * http://www.opensource.org/licenses/osl-3.0.php
11     *
12     *******************************************************/
13 ksteube 1312
14 ksteube 1811
15 jgs 82 #if !defined finley_MeshAdapterFactory_20040526_H
16     #define finley_MeshAdapterFactory_20040526_H
17 woo409 757 #include "system_dep.h"
18 jgs 82
19 jgs 472 extern "C" {
20 robwdcock 682 #include "../Finley.h"
21     #include "../Mesh.h"
22     #include "../RectangularMesh.h"
23 jgs 472 }
24    
25 jgs 203 #include "MeshAdapter.h"
26 jgs 82
27 robwdcock 682 #include "escript/AbstractContinuousDomain.h"
28 jgs 82
29     #include <boost/python/list.hpp>
30    
31 jgs 472 #include <sstream>
32    
33 jgs 82 namespace finley {
34     /**
35     \brief
36     A suite of factory methods for creating various MeshAdapters.
37    
38     Description:
39     A suite of factory methods for creating various MeshAdapters.
40     */
41    
42     /**
43     \brief
44 ksteube 1312 recovers mesg from a dump file
45     \param fileName Input - The name of the file.
46     */
47     FINLEY_DLL_API
48 jfenwick 1872 /* escript::AbstractContinuousDomain* loadMesh(const std::string& fileName);*/
49     escript::Domain_ptr loadMesh(const std::string& fileName);
50 ksteube 1312 /**
51     \brief
52 ksteube 1807 Read a mesh from a file. For MPI parallel runs fan out the mesh to multiple processes.
53 jgs 82 \param fileName Input - The name of the file.
54 jgs 121 \param integrationOrder Input - order of the quadrature scheme.
55     If integrationOrder<0 the integration order is selected independently.
56 gross 1059 \param reducedIntegrationOrder Input - order of the reduced quadrature scheme.
57     If reducedIntegrationOrder<0 the integration order is selected independently.
58 ksteube 1312 \param optimize Input - switches on the optimization of node labels
59 jgs 82 */
60 woo409 757 FINLEY_DLL_API
61 jfenwick 1872 // escript::AbstractContinuousDomain* readMesh(const std::string& fileName,
62     escript::Domain_ptr readMesh(const std::string& fileName,
63 gross 1059 int integrationOrder=-1,
64     int reducedIntegrationOrder=-1,
65 ksteube 1312 int optimize=0);
66 jgs 82 /**
67     \brief
68 gross 934 Read a gmsh mesh file
69     \param fileName Input - The name of the file.
70     \param numDim Input - spatial dimension
71     \param integrationOrder Input - order of the quadrature scheme.
72     If integrationOrder<0 the integration order is selected independently.
73     \param reducedIntegrationOrder Input - order of the reduced quadrature scheme.
74     If reducedIntegrationOrder<0 the integration order is selected independently.
75 ksteube 1312 \param optimize Input - switches on the optimization of node labels
76 gross 934 */
77     FINLEY_DLL_API
78 jfenwick 1872 // escript::AbstractContinuousDomain* readGmsh(const std::string& fileName,
79     escript::Domain_ptr readGmsh(const std::string& fileName,
80 gross 934 int numDim,
81     int integrationOrder=-1,
82     int reducedIntegrationOrder=-1,
83 ksteube 1312 int optimize=0);
84 gross 934 /**
85     \brief
86 jgs 123 Creates a rectangular mesh with n0 x n1 x n2 elements over the brick
87     [0,l0] x [0,l1] x [0,l2].
88 jgs 82
89 jgs 123 \param n0,n1,n2 Input - number of elements in each dimension
90 jgs 82 \param order Input - =1 or =2 gives the order of shape function
91 jgs 123 \param l0,l1,l2 Input - length of each side of brick
92 gross 1059 \param integrationOrder Input - order of the quadrature scheme.
93     If integrationOrder<0 the integration order is selected independently.
94     \param reducedIntegrationOrder Input - order of the reduced quadrature scheme.
95     If reducedIntegrationOrder<0 the integration order is selected independently.
96 jgs 121 \param useElementsOnFace Input - whether or not to use elements on face
97     \param periodic0, periodic1, periodic2 Input - whether or not boundary
98     conditions of the dimension are periodic
99 jfenwick 2519 \param useFullElementOrder
100     \param optimize
101 jgs 82 */
102 woo409 757 FINLEY_DLL_API
103 jfenwick 1872 // escript::AbstractContinuousDomain* brick(int n0=1,int n1=1,int n2=1,int order=1,
104     escript::Domain_ptr brick(int n0=1,int n1=1,int n2=1,int order=1,
105 jgs 123 double l0=1.0,double l1=1.0,double l2=1.0,
106 jgs 82 int periodic0=0,int periodic1=0,
107     int periodic2=0,
108     int integrationOrder=-1,
109 gross 1059 int reducedIntegrationOrder=-1,
110 ksteube 1312 int useElementsOnFace=0,
111     int useFullElementOrder=0,
112     int optimize=0);
113 jgs 82 /**
114 jgs 121 \brief
115 jgs 123 Creates a rectangular mesh with n0 x n1 elements over the brick
116     [0,l0] x [0,l1].
117 jgs 82
118 jgs 123 \param n0,n1 Input - number of elements in each dimension
119 jgs 82 \param order Input - =1 or =2 gives the order of shape function
120 jgs 123 \param l0,l1 Input - length of each side of brick
121 jgs 82 \param integrationOrder Input - order of the quadrature scheme.
122     If integrationOrder<0 the integration order is selected
123     independently.
124 gross 1059 \param reducedIntegrationOrder Input - order of the reduced quadrature scheme.
125     If reducedIntegrationOrder<0 the integration order is selected independently.
126 jgs 121 \param periodic0, periodic1 Input - whether or not the boundary
127     conditions of the dimension are periodic
128     \param useElementsOnFace Input - whether or not to use elements on face
129 jfenwick 2519 \param useFullElementOrder
130     \param optimize
131 jgs 82 */
132 woo409 757 FINLEY_DLL_API
133 jfenwick 1872 // escript::AbstractContinuousDomain* rectangle(int n0=1,int n1=1,int order=1,
134     escript::Domain_ptr rectangle(int n0=1,int n1=1,int order=1,
135 jgs 123 double l0=1.0, double l1=1.0,
136 jgs 82 int periodic0=false,int periodic1=false,
137     int integrationOrder=-1,
138 gross 1059 int reducedIntegrationOrder=-1,
139 ksteube 1312 int useElementsOnFace=0,
140     int useFullElementOrder=0,
141     int optimize=0);
142 jgs 82 /**
143     \brief
144     Merges a list of meshes into one list.
145     \param meshList Input - The list of meshes.
146     */
147 woo409 757 FINLEY_DLL_API
148 jfenwick 1872 // escript::AbstractContinuousDomain* meshMerge(const boost::python::list& meshList);
149     escript::Domain_ptr meshMerge(const boost::python::list& meshList);
150 jgs 82 /**
151     \brief
152     Detects matching faces in the mesh, removes them from the mesh
153     and joins the elements touched by the face elements.
154     \param meshList Input - The list of meshes.
155 jgs 121 \param safetyFactor Input - ??
156 jgs 82 \param tolerance Input - ??
157 ksteube 1312 \param optimize Input - switches on the optimization of node labels
158 jgs 82 */
159 woo409 757 FINLEY_DLL_API
160 jfenwick 1872 // escript::AbstractContinuousDomain* glueFaces(const boost::python::list& meshList,
161     escript::Domain_ptr glueFaces(const boost::python::list& meshList,
162 jgs 82 double safetyFactor=0.2,
163 gross 1059 double tolerance=1.e-8,
164 ksteube 1312 int optimize=0);
165 jgs 82 /**
166     \brief
167     Detects matching faces in the mesh and replaces them by joint elements.
168     \param meshList Input - The list of meshes.
169 jgs 121 \param safetyFactor Input - ??
170 jgs 82 \param tolerance Input - ??
171 ksteube 1312 \param optimize Input - switches on the optimization of node labels
172 jgs 82 */
173 woo409 757 FINLEY_DLL_API
174 jfenwick 1872 // escript::AbstractContinuousDomain* joinFaces(const boost::python::list& meshList,
175     escript::Domain_ptr joinFaces(const boost::python::list& meshList,
176 jgs 121 double safetyFactor=0.2,
177 gross 1059 double tolerance=1.e-8,
178 ksteube 1312 int optimize=0);
179 jgs 82
180     } // end of namespace
181     #endif

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26