starfish.core.source

Class SourceModule

java.lang.Object

starfish.core.common.CommandModule

starfish.core.source.SourceModule

public class SourceModule
extends CommandModule

Handles < source\ > command

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SourceModule.SurfaceSourceFactory interfaces for source factories
static interface	SourceModule.VolumeSourceFactory

Field Summary

Fields

Modifier and Type	Field and Description
double	boundary_charge
static java.util.HashMap<java.lang.String,SourceModule.SurfaceSourceFactory>	surface_source_factories
static java.util.HashMap<java.lang.String,SourceModule.VolumeSourceFactory>	volume_source_factories
protected java.util.ArrayList<VolumeSource>	volume_source_list

Fields inherited from class starfish.core.common.CommandModule

has_started

Constructor Summary

Constructors

Constructor and Description
SourceModule()

Method Summary

Modifier and Type	Method and Description
void	addVolumeSource(VolumeSource vol_source) adds new volume source
void	exit() function called prior to program exit
void	init() function called prior to start of processing input file
void	process(org.w3c.dom.Element element) reads element data and performs appropriate action
static void	registerSurfaceSource(java.lang.String name, SourceModule.SurfaceSourceFactory fac)
static void	registerVolumeSource(java.lang.String name, SourceModule.VolumeSourceFactory fac)
void	sampleSources() samples sources and adds particles or updates boundaries
void	start() function called prior to main loop

Methods inherited from class starfish.core.common.CommandModule

finish

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

volume_source_list

protected java.util.ArrayList<VolumeSource> volume_source_list

boundary_charge

public double boundary_charge

surface_source_factories

public static java.util.HashMap<java.lang.String,SourceModule.SurfaceSourceFactory> surface_source_factories

volume_source_factories

public static java.util.HashMap<java.lang.String,SourceModule.VolumeSourceFactory> volume_source_factories

Constructor Detail

SourceModule

public SourceModule()

Method Detail

init

public void init()

Description copied from class: CommandModule

function called prior to start of processing input file

Overrides:

init in class CommandModule

process

public void process(org.w3c.dom.Element element)

Description copied from class: CommandModule

reads element data and performs appropriate action

Specified by:

process in class CommandModule

Parameters:

element - XML element containing data objects

registerSurfaceSource

public static void registerSurfaceSource(java.lang.String name,
                                         SourceModule.SurfaceSourceFactory fac)

Parameters:

name -

fac -

registerVolumeSource

public static void registerVolumeSource(java.lang.String name,
                                        SourceModule.VolumeSourceFactory fac)

Parameters:

name -

fac -

sampleSources

public void sampleSources()

samples sources and adds particles or updates boundaries

addVolumeSource

public void addVolumeSource(VolumeSource vol_source)

adds new volume source

Parameters:

vol_source -

exit

public void exit()

Description copied from class: CommandModule

function called prior to program exit

Overrides:

exit in class CommandModule

start

public void start()

Description copied from class: CommandModule

function called prior to main loop

Overrides:

start in class CommandModule