GfsBoundary

Collaboration diagram for GfsBoundary:

Classes
	GfsBoundaryGradient
	GfsBoundaryInflowConstant
	GfsBoundaryOutflow
	GfsBoundaryPeriodic
Functions
GfsBoundary *	gfs_boundary_new (GfsBoundaryClass *klass, GfsBox *box, FttDirection d)
void	gfs_boundary_update (GfsBoundary *boundary)
void	gfs_boundary_send (GfsBoundary *boundary)
void	gfs_boundary_receive (GfsBoundary *boundary, FttTraverseFlags flags, gint max_depth)
void	gfs_boundary_synchronize (GfsBoundary *boundary)
GfsBc *	gfs_boundary_lookup_bc (GfsBoundary *b, GfsVariable *v)
void	gfs_boundary_set_default_bc (GfsBoundary *b, GfsBc *bc)
void	gfs_variable_set_default_bc (GfsVariable *v, GfsBc *bc)
void	gfs_boundary_add_bc (GfsBoundary *b, GfsBc *bc)

---

Detailed Description

One of the boundaries of a #GfsBox.

See also:

Syntax reference

---

Function Documentation

void gfs_boundary_add_bc	(	GfsBoundary *	b,
		GfsBc *	bc
	)

Parameters:

b	a #GfsBoundary.
bc	a #GfsBc.

Adds boundary condition bc to b.

GfsBc* gfs_boundary_lookup_bc	(	GfsBoundary *	b,
		GfsVariable *	v
	)

Parameters:

b	a #GfsBoundary.
v	a #GfsVariable.

Returns:

the #GfsBc associated with b and v.

GfsBoundary* gfs_boundary_new	(	GfsBoundaryClass *	klass,
		GfsBox *	box,
		FttDirection	d
	)

Parameters:

klass	a #GfsBoundaryClass.
box	a #GfsBox.
d	a direction.

Creates a new boundary of type klass for box in direction d.

This function fails if box has already a boundary in direction d.

Returns:

a new #GfsBoundary.

Here is the caller graph for this function:

void gfs_boundary_receive	(	GfsBoundary *	boundary,
		FttTraverseFlags	flags,
		gint	max_depth
	)

Parameters:

boundary	a #GfsBoundary.
flags	the traversal flags.
max_depth	the maximum depth of the traversal.

Calls the receive() method of boundary.

void gfs_boundary_send

(

GfsBoundary *

boundary

)

Parameters:

boundary

a #GfsBoundary.

Calls the send() method of boundary.

void gfs_boundary_set_default_bc	(	GfsBoundary *	b,
		GfsBc *	bc
	)

Parameters:

b	a #GfsBoundary.
bc	a #GfsBc.

Sets the default boundary condition for b to bc.

void gfs_boundary_synchronize

(

GfsBoundary *

boundary

)

Parameters:

boundary

a #GfsBoundary.

Calls the synchronize() method of boundary.

void gfs_boundary_update

(

GfsBoundary *

boundary

)

Parameters:

boundary

a #GfsBoundary.

Calls the update() method of boundary.

void gfs_variable_set_default_bc	(	GfsVariable *	v,
		GfsBc *	bc
	)

Parameters:

v	a #GfVariable.
bc	a #GfsBc.

Sets the default boundary condition for v to bc.