PDE class

the differential equation object. More...

Files
file	pde.h
	Class PDE: the differential equation object.
Classes
struct	sPDE
	Class PDE: Definition. More...
Typedefs
typedef struct sPDE	PDE
	Declaration of the PDE class as the PDE structure.
Functions
void	PDE_initDyn (PDE *thee)
	Construct the Dyn PDE datastructure inside the PDE structure.
void	PDE_killDyn (PDE *thee)
	Destruct the Dyn PDE datastructure inside the PDE structure.
int	PDE_checkDyn (PDE *thee)
	Checks to see if the Dyn PDE structure has been created.
void	PDE_setTime (PDE *thee, double mytime)
	Set the time variable in the Dyn PDE structure.
double	PDE_getTime (PDE *thee)
	Get the time variable from the Dyn PDE structure.
void	PDE_setUserStepHook (PDE *thee, void(*UserStepHook)(PDE *thee, AM *am, int ekey))
	Set the energy key variable in the Dyn PDE structure.
void	PDE_nullUserStepHook (PDE *thee)
	Set the UserStepHook function pointer to VNULL.
void	PDE_userStepHook (PDE *thee, AM *am, int ekey)
	Call the userStepHook function.
void	PDE_setEnergyKey (PDE *thee, int ekey)
	Set the energy key variable in the Dyn PDE structure.
int	PDE_getEnergyKey (PDE *thee)
	Get the energy key variable from the Dyn PDE structure.
void	PDE_setDim (PDE *thee, int d)
	Set the extrinsic spatial dimension.
void	PDE_setDimII (PDE *thee, int d)
	Set the extrinsic spatial dimension.
int	PDE_dim (PDE *thee)
	Return the extrinsic spatial dimension.
int	PDE_dimII (PDE *thee)
	Return the extrinsic spatial dimension.
int	PDE_vec (PDE *thee)
	Return the PDE product space dimension.
PDE *	PDE_ctor_default (void)
	Construct a fake differential equation object in case there is not one provided.
void	PDE_dtor_default (PDE **thee)
	Destroy a fake differential equation object.
int	PDE_sym (PDE *thee, int i, int j)
	Return the bilinear form minor symmetry (i,j).

---

Detailed Description

the differential equation object.

---

Typedef Documentation

typedef struct sPDE PDE

Declaration of the PDE class as the PDE structure.

Author:

Michael Holst

---

Function Documentation

int PDE_checkDyn

(

PDE *

thee

)

Checks to see if the Dyn PDE structure has been created.

Author:

Stephen Bond

Note:

Class Dyn: Non-Inlineable methods (dyn.c)

Returns:

Success enumeration

Parameters:

thee

Pointer to the differential equation object

PDE* PDE_ctor_default

(

void

)

Construct a fake differential equation object in case there is not one provided.

Author:

Michael Holst

Note:

Class PDE: Non-Inlineable methods (pde.c)

Returns:

Pointer to a new allocated PDE object

int PDE_dim

(

PDE *

thee

)

Return the extrinsic spatial dimension.

Author:

Michael Holst

Note:

Class PDE: Inlineable methods (pde.c)

Returns:

the extrinsic spatial dimension.

Parameters:

thee

Pointer to the PDE object

int PDE_dimII

(

PDE *

thee

)

Return the extrinsic spatial dimension.

Author:

Michael Holst

Note:

Class PDE: Inlineable methods (pde.c)

Returns:

the extrinsic spatial dimension.

Parameters:

thee

Pointer to the PDE object

void PDE_dtor_default

(

PDE **

thee

)

Destroy a fake differential equation object.

Author:

Michael Holst

Note:

Class PDE: Non-Inlineable methods (pde.c)

Returns:

None

Parameters:

thee

Pointer to the PDE object

int PDE_getEnergyKey

(

PDE *

thee

)

Get the energy key variable from the Dyn PDE structure.

Author:

Stephen Bond

Note:

Class Dyn: Non-Inlineable methods (dyn.c)

Returns:

None

Parameters:

thee

Pointer to the differential equation object

double PDE_getTime

(

PDE *

thee

)

Get the time variable from the Dyn PDE structure.

Author:

Stephen Bond

Note:

Class Dyn: Non-Inlineable methods (dyn.c)

Returns:

the time variable from the Dyn PDE structure

Parameters:

thee

Pointer to the differential equation object

void PDE_initDyn

(

PDE *

thee

)

Construct the Dyn PDE datastructure inside the PDE structure.

Author:

Stephen Bond

Note:

Class Dyn: Non-Inlineable methods (dyn.c)

Returns:

None

Parameters:

thee

Pointer to the differential equation object

void PDE_killDyn

(

PDE *

thee

)

Destruct the Dyn PDE datastructure inside the PDE structure.

Author:

Stephen Bond

Note:

Class Dyn: Non-Inlineable methods (dyn.c)

Returns:

None

Parameters:

thee

Pointer to the differential equation object

void PDE_nullUserStepHook

(

PDE *

thee

)

Set the UserStepHook function pointer to VNULL.

Author:

Stephen Bond

Note:

Class Dyn: Non-Inlineable methods (dyn.c)

Returns:

None

Parameters:

thee

Pointer to the differential equation object

void PDE_setDim	(	PDE *	thee,
		int	d
	)

Set the extrinsic spatial dimension.

Author:

Michael Holst

Note:

Class PDE: Inlineable methods (pde.c)

Returns:

None

Parameters:

	thee	Pointer to the PDE object
	d	the extrinsic spatial dimension

void PDE_setDimII	(	PDE *	thee,
		int	d
	)

Set the extrinsic spatial dimension.

Author:

Michael Holst

Note:

Class PDE: Inlineable methods (pde.c)

Returns:

None

Parameters:

	thee	Pointer to the PDE object
	d	the intrinsic spatial dimension

void PDE_setEnergyKey	(	PDE *	thee,
		int	ekey
	)

Set the energy key variable in the Dyn PDE structure.

Author:

Stephen Bond

Note:

Class Dyn: Non-Inlineable methods (dyn.c)

Returns:

None

Parameters:

	thee	Pointer to the differential equation object
	ekey	the energy key variable in the Dyn PDE structure

void PDE_setTime	(	PDE *	thee,
		double	mytime
	)

Set the time variable in the Dyn PDE structure.

Author:

Stephen Bond

Note:

Class Dyn: Non-Inlineable methods (dyn.c)

Returns:

None

Parameters:

	thee	Pointer to the differential equation object
	mytime	the time variable in the Dyn PDE structure

void PDE_setUserStepHook	(	PDE *	thee,
		void(*)(PDE *thee, AM *am, int ekey)	UserStepHook
	)

Set the energy key variable in the Dyn PDE structure.

Author:

Stephen Bond

Note:

Class Dyn: Non-Inlineable methods (dyn.c)

Returns:

None

Parameters:

	thee	Pointer to the differential equation object
	UserStepHook	Pointer to user defined external function

int PDE_sym	(	PDE *	thee,
		int	i,
		int	j
	)

Return the bilinear form minor symmetry (i,j).

Author:

Michael Holst

Note:

Class PDE: Non-Inlineable methods (pde.c)

Returns:

the bilinear form minor symmetry (i,j).

Parameters:

	thee	Pointer to the PDE object
	i	index for the symmetry test
	j	index for the symmetry test

void PDE_userStepHook	(	PDE *	thee,
		AM *	am,
		int	ekey
	)

Call the userStepHook function.

Author:

Stephen Bond

Note:

Class Dyn: Non-Inlineable methods (dyn.c)

Returns:

None

Parameters:

	thee	Pointer to the differential equation object
	am	Pointer to class AM
	ekey	the energy key variable in the Dyn PDE structure

int PDE_vec

(

PDE *

thee

)

Return the PDE product space dimension.

Author:

Michael Holst

Note:

Class PDE: Inlineable methods (pde.c)

Returns:

the PDE product space dimension.

Parameters:

thee

Pointer to the PDE object