DiscreteDeltaFn Class Reference

Pure virtual base class to encapsulate discrete delta function operator. More...

#include <DiscreteDeltaFn.H>

Inheritance diagram for DiscreteDeltaFn:

[legend]List of all members.

Public Member Functions
	DiscreteDeltaFn ()
	constructor
	DiscreteDeltaFn (Real a_epsilon)
	constructor with radius -- calls corresponding define fn.
virtual	~DiscreteDeltaFn ()
	destructor
virtual void	define (Real a_epsilon)=0
	define function
virtual Real	epsilon () const=0
	returns epsilon
virtual DiscreteDeltaFn *	clone () const=0
	make a copy of this delta function
virtual Real	evaluateDelta (Real a_radius) const=0
	evaluate the delta function at the given radius
virtual Real	integralDelta (Real a_radius) const=0
	returns the integral from 0 to radius of delta
virtual Real	computeK (RealVect &a_radius, int a_idir, int a_jdir) const=0
	returns the kernel_{ij} at radius r
virtual void	sumForce (FArrayBox &a_sum, const RealVect &a_force, const Box &a_box, const RealVect &a_position, const RealVect &a_origin, Real a_dx)=0
	returns sum_j force_j kernel_ij over a box
virtual void	sumForce (FArrayBox &a_sum, const RealVect &a_force, const Box &a_box, int a_dir, int a_destComp, const RealVect &a_position, const RealVect &a_origin, Real a_dx)=0
	returns sum_j force_j kernel_ij over a box
virtual Real	computeLapDelta (Real a_radius) const=0
	returns laplacian(delta) at radius r

---

Detailed Description

Pure virtual base class to encapsulate discrete delta function operator.

This is a pure virtual base class to encapsulate the discrete delta function which will be used to spread particle forces to the computational mesh. The parameter epsilon defines the spreading radius of the discrete delta fn.

---

Constructor & Destructor Documentation

DiscreteDeltaFn::DiscreteDeltaFn (   )  [inline]

constructor

DiscreteDeltaFn::DiscreteDeltaFn (  Real  a_epsilon  )  [inline]

constructor with radius -- calls corresponding define fn.

virtual DiscreteDeltaFn::~DiscreteDeltaFn (   )  [inline, virtual]

destructor

---

Member Function Documentation

virtual DiscreteDeltaFn* DiscreteDeltaFn::clone (   )  const [pure virtual]

make a copy of this delta function Implemented in PolynomialDelta.

virtual Real DiscreteDeltaFn::computeK (  RealVect &  a_radius, int  a_idir, int  a_jdir )  const [pure virtual]

returns the kernel_{ij} at radius r Implemented in PolynomialDelta.

virtual Real DiscreteDeltaFn::computeLapDelta (  Real  a_radius  )  const [pure virtual]

returns laplacian(delta) at radius r Implemented in PolynomialDelta.

virtual void DiscreteDeltaFn::define (  Real  a_epsilon  )  [pure virtual]

define function Implemented in PolynomialDelta.

virtual Real DiscreteDeltaFn::epsilon (   )  const [pure virtual]

returns epsilon Implemented in PolynomialDelta.

virtual Real DiscreteDeltaFn::evaluateDelta (  Real  a_radius  )  const [pure virtual]

evaluate the delta function at the given radius Implemented in PolynomialDelta.

virtual Real DiscreteDeltaFn::integralDelta (  Real  a_radius  )  const [pure virtual]

returns the integral from 0 to radius of delta Implemented in PolynomialDelta.

virtual void DiscreteDeltaFn::sumForce (  FArrayBox &  a_sum, const RealVect &  a_force, const Box &  a_box, int  a_dir, int  a_destComp, const RealVect &  a_position, const RealVect &  a_origin, Real  a_dx )  [pure virtual]

returns sum_j force_j kernel_ij over a box this version computes a single (idir) component and places it in the destComp component of a_sum. this is done over a box for effeciency. Implemented in PolynomialDelta.

virtual void DiscreteDeltaFn::sumForce (  FArrayBox &  a_sum, const RealVect &  a_force, const Box &  a_box, const RealVect &  a_position, const RealVect &  a_origin, Real  a_dx )  [pure virtual]

returns sum_j force_j kernel_ij over a box sum is a SpaceDim-component fab which will contain the sum this is done over a box for effeciency. Implemented in PolynomialDelta.

---

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

• DiscreteDeltaFn.H

---