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
Line Class Reference

Supply functions for generating a 1D line geometry. More...

#include <geometry_1d.h>

Inheritance diagram for Line:
Geometry

Public Member Functions

 Line ()
 Constructor. More...
 
virtual ~Line ()
 Desturctor.
 
virtual bool operator() (double x, double y, double z) const
 Level set function of a 1D line with center at zero. More...
 
virtual void getBoundingBox (double &xmin, double &xmax, double &ymin, double &ymax, double &zmin, double &zmax)
 Calculates the bounding box of 1D line centered at zero. More...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Destructor.
 

Detailed Description

Supply functions for generating a 1D line 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
2015/03/13

Created on: 2015/03/13

Constructor & Destructor Documentation

Line::Line ( )

Constructor.

This line object is centered at zero with length on the left being leftLen and that on the right being rightLen

Member Function Documentation

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

Calculates the bounding box of 1D line centered at zero.

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

Implements Geometry.

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

Level set function of a 1D line with center at zero.

The level set function is $ -\mbox{rightLen} \leq x \leq \mbox{leftLen} $

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

Implements Geometry.


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