libMesh: A C++ Finite Element Library

KIRK, BENJAMIN (JSC-EG) (NASA) writes:
 > I need some help thinking of a good method name...
 > 
 > Here is what I want:
 > 
 > Point normal = elem->foo1(s);
 > // returns a vector normal to side s.  
 > // the magnitude of this vector is the area
 > // of side s.
 > 
 > Real lav = elem->foo2(s);
 > // returns the length or area of side s (2D, 3D respectively)
 > // s defaults to libMesh::invalid_uint, in which case 
 > // elem->foo2() returns the length/area/volume of the element.
 > 
 > So foo1 should probably be called normal(), but what about foo2?  I
 > suggested size() some time back, but as John pointed out that name generally
 > has a different meaning thanks to the STL.  What has a similar meaning to
 > length/area/volume but is dimension-independent??

foo2() is dimension independent ;) but I would suggest

elem->size_of_side(s)

It's longer but tells exactly what it's doing...

-John

>>>>> On Fri, 27 Feb 2004 08:59:33 -0600, "KIRK, BENJAMIN (JSC-EG) (NASA)" <benjamin.kirk-1@...> said:

Ben> So foo1 should probably be called normal(), but what about foo2?  I
Ben> suggested size() some time back, but as John pointed out that name generally
Ben> has a different meaning thanks to the STL.  What has a similar meaning to
Ben> length/area/volume but is dimension-independent??

I'd just call it volume() or vol() since it's atop the language
hierarchy, and then put a comment in the documentation along the lines
of:

Returns the volume/area/length of side s or the element itself with no
argument.

Bill.

-- 
Bill Barth                   |   Home: (512) 797-3045
bbarth@...  |   Work: (512) 471-4069
Office: WRW 111              |   Fax:  (512) 232-3357