revision 102 by jgs, Wed Dec 15 07:08:39 2004 UTC revision 121 by jgs, Fri May 6 04:26:16 2005 UTC
# Line 1  Line 1
1  /* \$Id\$  /* \$Id\$ */
2  /*  /*
3   ******************************************************************************   ******************************************************************************
4   *                                                                            *   *                                                                            *
# Line 35  namespace finley { Line 35  namespace finley {
35       \brief       \brief
36       Read a mesh from a file       Read a mesh from a file
37       \param fileName Input -  The name of the file.       \param fileName Input -  The name of the file.
38         \param integrationOrder Input - order of the quadrature scheme.
39         If integrationOrder<0 the integration order is selected independently.
40    */    */
42                       int integrationOrder=-1);                       int integrationOrder=-1);
# Line 43  namespace finley { Line 45  namespace finley {
45       Creates a rectangular mesh with n1 x n2 x n3 elements over the brick       Creates a rectangular mesh with n1 x n2 x n3 elements over the brick
46       [0,l1] x [0,l2] x [0,l3].       [0,l1] x [0,l2] x [0,l3].
47
48       \param n1,n2,n3 Input -       \param n1,n2,n3 Input - number of elements in each dimension
49       \param order Input - =1 or =2 gives the order of shape function       \param order Input - =1 or =2 gives the order of shape function
50       \param l1,l2,l3 Input -       \param l1,l2,l3 Input - length of each side of brick
51       \param integrationOrder Input - order of the quadrature scheme.       \param integrationOrder Input - order of the quadrature scheme.
52         \param useElementsOnFace Input - whether or not to use elements on face
53         \param periodic0, periodic1, periodic2 Input - whether or not boundary
54         conditions of the dimension are periodic
55    */    */
56    escript::AbstractContinuousDomain* brick(int n1=1,int n2=1,int n3=1,int order=1,    escript::AbstractContinuousDomain* brick(int n1=1,int n2=1,int n3=1,int order=1,
57              double l1=1.0,double l2=1.0,double l3=1.0,              double l1=1.0,double l2=1.0,double l3=1.0,
# Line 55  namespace finley { Line 60  namespace finley {
60              int integrationOrder=-1,              int integrationOrder=-1,
61              int useElementsOnFace=0);              int useElementsOnFace=0);
62    /**    /**
63       \brdirief       \brief
64       Creates a rectangular mesh with n1 x n2 elements over the brick       Creates a rectangular mesh with n1 x n2 elements over the brick
65       [0,l1] x [0,l2].       [0,l1] x [0,l2].
66
67       \param n1,n2 Input -       \param n1,n2 Input - number of elements in each dimension
68       \param order Input - =1 or =2 gives the order of shape function       \param order Input - =1 or =2 gives the order of shape function
69       \param l1,l2 Input -       \param l1,l2 Input - length of each side of brick
70       \param integrationOrder Input - order of the quadrature scheme.       \param integrationOrder Input - order of the quadrature scheme.
71       If integrationOrder<0 the integration order is selected       If integrationOrder<0 the integration order is selected
72       independently.       independently.
73         \param periodic0, periodic1 Input - whether or not the boundary
74         conditions of the dimension are periodic
75         \param useElementsOnFace Input - whether or not to use elements on face
76    */    */
77    escript::AbstractContinuousDomain* rectangle(int n1=1,int n2=1,int order=1,    escript::AbstractContinuousDomain* rectangle(int n1=1,int n2=1,int order=1,
78                        double l1=1.0, double l2=1.0,                        double l1=1.0, double l2=1.0,
# Line 74  namespace finley { Line 82  namespace finley {
82    /**    /**
83       \brief       \brief
84       Creates an equidistant mesh with n elements over the interval [0,l].       Creates an equidistant mesh with n elements over the interval [0,l].
85       \param n1 Input -       \param n1 Input - number of elements
86       \param order Input - =1 or =2 gives the order of shape function.       \param order Input - =1 or =2 gives the order of shape function.
87         \param l1 Input - length of the brick
88       \param integrationOrder Input - order of the quadrature scheme.       \param integrationOrder Input - order of the quadrature scheme.
89       If integrationOrder<0 the integration order is selected       If integrationOrder<0 the integration order is selected
90       independently.       independently.
91         \param periodic0 Input - whether or not the boundary conditions are
92         periodic
93         \param useElementsOnFace Input - whether or not to use the elements
94         on the face
95    */    */
96    escript::AbstractContinuousDomain* interval(int n1=1,int order=1,double l1=1.0,    escript::AbstractContinuousDomain* interval(int n1=1,int order=1,double l1=1.0,
97                       int periodic0=false,                       int periodic0=false,
# Line 95  namespace finley { Line 108  namespace finley {
108       Detects matching faces in the mesh, removes them from the mesh       Detects matching faces in the mesh, removes them from the mesh
109       and joins the elements touched by the face elements.       and joins the elements touched by the face elements.
110       \param meshList Input - The list of meshes.       \param meshList Input - The list of meshes.
111       \param safetyFacto Input - ??       \param safetyFactor Input - ??
112       \param tolerance Input - ??       \param tolerance Input - ??
113    */    */
114    escript::AbstractContinuousDomain* glueFaces(const boost::python::list& meshList,    escript::AbstractContinuousDomain* glueFaces(const boost::python::list& meshList,
# Line 105  namespace finley { Line 118  namespace finley {
118       \brief       \brief
119       Detects matching faces in the mesh and replaces them by joint elements.       Detects matching faces in the mesh and replaces them by joint elements.
120       \param meshList Input - The list of meshes.       \param meshList Input - The list of meshes.
121       \param safetyFacto Input - ??       \param safetyFactor Input - ??
122       \param tolerance Input - ??       \param tolerance Input - ??
123    */    */
124    escript::AbstractContinuousDomain* joinFaces(const boost::python::list& meshList,    escript::AbstractContinuousDomain* joinFaces(const boost::python::list& meshList,
125              double safety_factor=0.2,              double safetyFactor=0.2,
126              double tolerance=100.*std::numeric_limits<double>::epsilon());              double tolerance=100.*std::numeric_limits<double>::epsilon());
127
128  } // end of namespace  } // end of namespace

Legend:
 Removed from v.102 changed lines Added in v.121