bruce/src/BruceFactory.h

/* $Id$ */
/* 
 ******************************************************************************
 *                                                                            *
 *       COPYRIGHT  ACcESS 2005 -  All Rights Reserved                        *
 *                                                                            *
 * This software is the property of ACcESS. No part of this code              *
 * may be copied in any form or by any means without the expressed written    *
 * consent of ACcESS.  Copying, use or modification of this software          *
 * by any unauthorised person is illegal unless that person has a software    *
 * license agreement with ACcESS.                                             *
 *                                                                            *
 ******************************************************************************
*/
                                                                           
#if !defined bruce_BruceFactory_20050901_H
#define bruce_BruceFactory_20050901_H

#include "escript/Data/AbstractContinuousDomain.h"
#include "bruce/Bruce/Bruce.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 
     [0,l0] x [0,l1] x [0,l2].

     \param n0,n1,n2 Input - number of elements in each dimension
     \param l0,l1,l2 Input - length of each side of brick
  */
  escript::AbstractContinuousDomain* brick(int n0=1,int n1=1,int n2=1,
                                   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
     [0,l0] x [0,l1].

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

#endif
1	/* $Id$ */
2	/*
3	******************************************************************************
4	* *
5	* COPYRIGHT ACcESS 2005 - All Rights Reserved *
6	* *
7	* This software is the property of ACcESS. No part of this code *
8	* may be copied in any form or by any means without the expressed written *
9	* consent of ACcESS. Copying, use or modification of this software *
10	* by any unauthorised person is illegal unless that person has a software *
11	* license agreement with ACcESS. *
12	* *
13	******************************************************************************
14	*/
15
16	#if !defined bruce_BruceFactory_20050901_H
17	#define bruce_BruceFactory_20050901_H
18
19	#include "escript/Data/AbstractContinuousDomain.h"
20	#include "bruce/Bruce/Bruce.h"
21
22	namespace bruce {
23
24	/**
25	\brief
26	A suite of factory methods for creating various Bruces.
27
28	Description:
29	A suite of factory methods for creating various Bruces.
30	*/
31
32	/**
33	\brief
34	Creates a rectangular mesh with n0 x n1 x n2 elements over the brick
35	[0,l0] x [0,l1] x [0,l2].
36
37	\param n0,n1,n2 Input - number of elements in each dimension
38	\param l0,l1,l2 Input - length of each side of brick
39	*/
40	escript::AbstractContinuousDomain* brick(int n0=1,int n1=1,int n2=1,
41	double l0=1.0,double l1=1.0,double l2=1.0);
42
43	/**
44	\brief
45	Creates a rectangular mesh with n0 x n1 elements over the rectangle
46	[0,l0] x [0,l1].
47
48	\param n0,n1 Input - number of elements in each dimension
49	\param l0,l1 Input - length of each side of brick
50	*/
51	escript::AbstractContinuousDomain* rectangle(int n0=1,int n1=1,
52	double l0=1.0, double l1=1.0);
53
54	} // end of namespace
55
56	#endif
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision