Source terms

Name

Source terms -- Variable-dependent source terms

Synopsis


#include <gfs.h>


#define     GFS_SOURCE                      (obj)
#define     GFS_IS_SOURCE                   (obj)
#define     GFS_SOURCE_CLASS                (klass)

struct      GfsSource;
struct      GfsSourceClass;

GfsSourceClass* gfs_source_class            (void);
void        gfs_velocity_sources            (GfsDomain *domain,
                                             GfsAdvectionParams *par);

Description

GfsSource is a generic object derived from GfsEvent and used to associate a source term to a given variable.

The syntax in parameter files is as follows:

[ GfsEvent ] NAME

where NAME is the name of the variable to associate the source term to.

Details

GFS_SOURCE()

#define     GFS_SOURCE(obj)

obj : 


GFS_IS_SOURCE()

#define     GFS_IS_SOURCE(obj)

obj : 


GFS_SOURCE_CLASS()

#define     GFS_SOURCE_CLASS(klass)

klass : 


struct GfsSource

struct GfsSource {
  /*< private >*/
  GfsEvent parent;

  /*< public >*/
  GfsVariable * v;
};


struct GfsSourceClass

struct GfsSourceClass;


gfs_source_class ()

GfsSourceClass* gfs_source_class            (void);

Returns : 


gfs_velocity_sources ()

void        gfs_velocity_sources            (GfsDomain *domain,
                                             GfsAdvectionParams *par);

Adds the corresponding source term to each component of the velocity.

domain : a GfsDomain.
par : the GfsAdvectionParams.