GeneralFunctionInterface Class Reference

#include <generalfunctioninterface.h>

Inheritance diagram for GeneralFunctionInterface:

[legend]

List of all members.

Public Member Functions
	GeneralFunctionInterface (unsigned domainDim, unsigned imageDim)
unsigned	getDomainDim () const
unsigned	getImageDim () const
unsigned	n_components () const
virtual double	operator() (const VecDouble &p, unsigned int component=0) const =0
virtual bool	isInDomain (const VecDouble &p, unsigned component=0) const
virtual void	setParameters (const VecDouble &parameters)
void	plotInLine (VecDouble &p1, VecDouble &p2, unsigned npts, std::ostream &out, unsigned cmp=0)
virtual	~GeneralFunctionInterface ()
virtual void	vector_value (const VecDouble &p, VecDouble &values) const
Private Attributes
unsigned	_domainDim
unsigned	_imageDim

---

Detailed Description

GeneralFunctionInterface

Definition at line 10 of file generalfunctioninterface.h.

---

Constructor & Destructor Documentation

GeneralFunctionInterface::GeneralFunctionInterface	(	unsigned	domainDim,
		unsigned	imageDim
	)			[inline]

Definition at line 15 of file generalfunctioninterface.h.

    :_domainDim(domainDim),_imageDim(imageDim){}  

virtual GeneralFunctionInterface::~GeneralFunctionInterface

(

)

[inline, virtual]

Definition at line 36 of file generalfunctioninterface.h.

{}

---

Member Function Documentation

unsigned GeneralFunctionInterface::getDomainDim

(

)

const [inline]

Definition at line 17 of file generalfunctioninterface.h.

{return _domainDim;}

unsigned GeneralFunctionInterface::getImageDim

(

)

const [inline]

Definition at line 18 of file generalfunctioninterface.h.

{return _imageDim;}

bool GeneralFunctionInterface::isInDomain	(	const VecDouble &	p,
		unsigned	component = 0
	)			const [virtual]

Reimplemented in FCubeBoundaryCondition, FCompoundVector, FConst3D, FCylinderRegion, FDomainComplement, FDomainUnion, FWellCondition, and Function1D.

Definition at line 26 of file generalfunctioninterface.cpp.

{
  
  throw new Exception("GeneralFunctionInterface::IsInDomain not defined for %s\n",typeid(*this).name()); 
  return false;
}

unsigned GeneralFunctionInterface::n_components

(

)

const [inline]

Definition at line 19 of file generalfunctioninterface.h.

{return _imageDim;}

virtual double GeneralFunctionInterface::operator()	(	const VecDouble &	p,
		unsigned int	component = 0
	)			const [pure virtual]

Implemented in FCubeBoundaryCondition, ConstVectorFunction, FChessBoard3D, FCompoundVector, FConst3D, FConstSphereRegion, FCylinderRegion, FDomainComplement, FDomainUnion, FPlane, FWellCondition, FWellsSource, VectorFunction, Function1D, and TwoTracksVectorFunction.

void GeneralFunctionInterface::plotInLine	(	VecDouble &	p1,
		VecDouble &	p2,
		unsigned	npts,
		std::ostream &	out,
		unsigned	cmp = 0
	)

Definition at line 5 of file generalfunctioninterface.cpp.

{
  assert(p1.size() == getDomainDim());
  assert(p2.size() == getDomainDim());
    
  VecDouble dp=p2;
  VecDouble p=p1;
  dp-=p1;
  dp*=1.0/(npts-1);
  double dx = dp.l2_norm();
  double x=0;
  for(unsigned i=0;i<npts;i++)
  {
    fout << x   << " " << (*this)(p,cmp) << std::endl;
    x+=dx;
    p+=dp;
  }
}

virtual void GeneralFunctionInterface::setParameters

(

const VecDouble &

parameters

)

[inline, virtual]

Reimplemented in DFChaventMobility, FBucleyLeverettTotalMob, FChaventMobility, FLinear, and FQuadratic.

Definition at line 25 of file generalfunctioninterface.h.

  {

    printf("GeneralFunctionInterface::setParameters(const VecDouble &parameters [size=%d] ) not overloaded\n",parameters.size());
    assert(0);

  }

virtual void GeneralFunctionInterface::vector_value	(	const VecDouble &	p,
		VecDouble &	values
	)			const [inline, virtual]

Definition at line 38 of file generalfunctioninterface.h.

  {
      printf("Warning: Invalid Base Method called for point %g-%d\n",p(0),values.size());
      std::cout << "Warning: Invali Base Method called" << std::endl;
      assert(0);
  }

---

Member Data Documentation

unsigned GeneralFunctionInterface::_domainDim [private]

Definition at line 12 of file generalfunctioninterface.h.

unsigned GeneralFunctionInterface::_imageDim [private]

Definition at line 13 of file generalfunctioninterface.h.

---

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

• generalfunctioninterface.h
• generalfunctioninterface.cpp