Lagrangian Particle Code for The Simulation of 2D/3D Fluid Dynamics
 All Classes Files Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
Geometry Class Referenceabstract

An abstract class for the initialization of the geometry of fluid objects. More...

#include <geometry.h>

Inheritance diagram for Geometry:
Ball Disk DiskLeft DiskRight Line

Public Member Functions

virtual ~Geometry ()
 Destructor.
 
virtual bool operator() (double x, double y, double z) const =0
 Level set function of particle geometry. More...
 
virtual void getBoundingBox (double &xmin, double &xmax, double &ymin, double &ymax, double &zmin, double &zmax)=0
 Calculates the bounding box of a geometric shape. More...
 

Detailed Description

An abstract class for the initialization of the geometry of fluid objects.

This class can be used as a function object: the operator() is overloaded as the level set function of particle geometry

Author
Chen, Hsin-Chiang (morri.nosp@m.sche.nosp@m.n2008.nosp@m.@gma.nosp@m.il.co.nosp@m.m)
Version
1.0
Date
2014/08/08

Created on: 2014/06/07

Member Function Documentation

virtual void Geometry::getBoundingBox ( double &  xmin,
double &  xmax,
double &  ymin,
double &  ymax,
double &  zmin,
double &  zmax 
)
pure virtual

Calculates the bounding box of a geometric shape.

For example, for a ball in 3D with center (xcen, ycen, zcen) and radius r the bounding box is calculated as ([xcen-r,xcen+r],[ycen-r,ycen+r],[zcen-r,zcen+r])

Parameters
[out]xminThe minimum in x-coordinate
[out]xmaxThe maximum in x-coordinate
[out]yminThe minimum in y-coordinate
[out]ymaxThe maximum in y-coordinate
[out]zminThe minimum in z-coordinate
[out]zmaxThe maximum in z-coordinate
Returns
None

Implemented in Disk, DiskRight, Ball, DiskLeft, and Line.

virtual bool Geometry::operator() ( double  x,
double  y,
double  z 
) const
pure virtual

Level set function of particle geometry.

Parameters
[in]xThe x-coordinate
[in]yThe y-coordinate
[in]zThe z-coordinate
Returns
true if (x,y,z) is inside the level set function; false otherwise

Implemented in Disk, DiskRight, Ball, DiskLeft, and Line.


The documentation for this class was generated from the following file: