dyn.h File Reference

Class Dyn: dynamics library. More...

#include <mc/mc_base.h>
#include <mc/aprx.h>
#include <mc/nam.h>

Include dependency graph for dyn.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	sSVio
	Contains public data memebers for the SVio class. More...
struct	DynPDE
	Class DynPDE definition. More...
Typedefs
typedef struct sSVio	SVio
	Delcaration of the SVio class as the SVio structure.
Enumerations
enum	DYNtype { SIMP_TYPE, TDEP_TYPE, NLIN_TYPE }
	Class Dyn: Parameters and datatypes. More...
Functions
void	AM_tSolve (AM *thee, int meth, double dt, double t0, int numstep, int pfreq, int efreq, int ekeytotal, DYNtype pdetype, double ltol, int lmax, SVio *vsock)
	Solution of Time-Dependent problems by Method of Lines.
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.
SVio *	SVio_ctor (void)
	Construct the Vio socket container object.
void	SVio_dtor (SVio **vsock)
	Destroy the Vio socket container object.
SVio *	Vsh_SVioSetup (Vsh *thee, char *key)
	Setup for I/O commands using SVio.
void	Vsh_SVioCleanup (Vsh *thee, SVio **vsock)
	Cleanup after I/O commands using SVio.
void	SVio_initStructure (SVio *thee, const char *rwkey, const char *iodev, const char *iofmt, const char *iohost, const char *iofile, char *buf, int bufsize, int ptype)
	Initialize the Vio socket container object.
int	SVio_bufSize (SVio *thee)
	Return the length of the internal buffer.
char *	SVio_bufGive (SVio *thee)
	Return the pointer to the internal buffer.
void	SVio_bufTake (SVio *thee, char *buf, int bufsize)
	Set the pointer to the internal buffer.
void	Aprx_writeSVio (Aprx *thee, int plabel, Bvec *w0, SVio *vsock)
	Write a finite element mesh or mesh function to a socket.

---

Detailed Description

Class Dyn: dynamics library.

Author:

Stephen Bond and Michael Holst

Note:

None

Version:

Id

dyn.h,v 1.8 2009/04/24 22:54:13 fetk Exp

Attention:

 *
 * MC = < Manifold Code >
 * Copyright (C) 1994--2008 Michael Holst
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 *  

---

Function Documentation

void Vsh_SVioCleanup	(	Vsh *	thee,
		SVio **	vsock
	)

Cleanup after I/O commands using SVio.

Author:

Stephen Bond

Note:

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

Returns:

None

Parameters:

	thee	Pointer to the shell with environment variables
	vsock	socket for reading/writing a finite element mesh or mesh function

SVio* Vsh_SVioSetup	(	Vsh *	thee,
		char *	key
	)

Setup for I/O commands using SVio.

Author:

Stephen Bond

Note:

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

Returns:

socket for reading/writing a finite element mesh or mesh function

Parameters:

	thee	Pointer to the shell with environment variables
	key	Pointer to I/O commands using SVio