bruce/src/BruceFactory.h

/* $Id$ */
/* 
 ************************************************************
 *          Copyright 2006 by ACcESS MNRF                   *
 *                                                          *
 *              http://www.access.edu.au                    *
 *       Primary Business: Queensland, Australia            *
 *  Licensed under the Open Software License version 3.0    *
 *     http://www.opensource.org/licenses/osl-3.0.php       *
 *                                                          *
 ************************************************************
*/

#if !defined bruce_BruceFactory_20050901_H
#define bruce_BruceFactory_20050901_H
#include "system_dep.h"
#include "escript/AbstractContinuousDomain.h"

namespace bruce {

  /**
     \brief
     A suite of factory methods for creating various Bruces.

     Description:
     A suite of factory methods for creating various Bruces.
  */
 
  /**
     \brief
     Creates a rectangular mesh with n0 x n1 x n2 elements over the brick 
     [l0,0,0] x [0,l1,0] x [0,0,l2].

     \param n0,n1,n2 Input - number of elements in each dimension
     \param l0,l1,l2 Input - length of each side of brick
  */
  BRUCE_DLL_API escript::AbstractContinuousDomain* brick(int n0=2, int n1=2, int n2=2,
                                   double l0=1.0, double l1=1.0, double l2=1.0);

  /**
     \brief
     Creates a rectangular mesh with n0 x n1 elements over the rectangle
     [l0,0] x [0,l1].

     \param n0,n1 Input - number of elements in each dimension
     \param l0,l1 Input - length of each side of rectangle
  */
  BRUCE_DLL_API escript::AbstractContinuousDomain* rectangle(int n0=2, int n1=2,
                               double l0=1.0, double l1=1.0);
 
} // end of namespace

#endif
1	jgs	150	/* $Id$ */
2			/*
3	elspeth	627	************************************************************
4			* Copyright 2006 by ACcESS MNRF *
5			* *
6			* http://www.access.edu.au *
7			* Primary Business: Queensland, Australia *
8			* Licensed under the Open Software License version 3.0 *
9			* http://www.opensource.org/licenses/osl-3.0.php *
10			* *
11			************************************************************
12	jgs	150	*/
13	jgs	151
14	jgs	150	#if !defined bruce_BruceFactory_20050901_H
15			#define bruce_BruceFactory_20050901_H
16	woo409	742	#include "system_dep.h"
17	robwdcock	682	#include "escript/AbstractContinuousDomain.h"
18	jgs	150
19			namespace bruce {
20
21			/**
22			\brief
23			A suite of factory methods for creating various Bruces.
24
25			Description:
26			A suite of factory methods for creating various Bruces.
27			*/
28
29			/**
30			\brief
31			Creates a rectangular mesh with n0 x n1 x n2 elements over the brick
32	jgs	151	[l0,0,0] x [0,l1,0] x [0,0,l2].
33	jgs	150
34			\param n0,n1,n2 Input - number of elements in each dimension
35			\param l0,l1,l2 Input - length of each side of brick
36			*/
37	woo409	742	BRUCE_DLL_API escript::AbstractContinuousDomain* brick(int n0=2, int n1=2, int n2=2,
38	jgs	151	double l0=1.0, double l1=1.0, double l2=1.0);
39	jgs	150
40			/**
41			\brief
42			Creates a rectangular mesh with n0 x n1 elements over the rectangle
43	jgs	151	[l0,0] x [0,l1].
44	jgs	150
45			\param n0,n1 Input - number of elements in each dimension
46	jgs	153	\param l0,l1 Input - length of each side of rectangle
47	jgs	150	*/
48	woo409	742	BRUCE_DLL_API escript::AbstractContinuousDomain* rectangle(int n0=2, int n1=2,
49	jgs	151	double l0=1.0, double l1=1.0);
50	jgs	150
51			} // end of namespace
52
53			#endif
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision