starfish.core.source

Class VolumeSource

java.lang.Object

starfish.core.source.Source

starfish.core.source.VolumeSource

Direct Known Subclasses:

VolumePreloadSource

public class VolumeSource
extends Source

creates particles in the simulation volume

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldCollection2D	dn
protected int	i_sample
protected int	j_sample
protected double	num_rem
protected Mesh	sample_mesh
protected FieldCollection2D	temp

Fields inherited from class starfish.core.source.Source

circuit_model, mdot0, mp_rem, name, num_mp, source_mat, spline

Constructor Summary

Constructors

Constructor and Description
VolumeSource(java.lang.String name, Material source_mat)

Method Summary

Modifier and Type	Method and Description
void	clearDn()
FieldCollection2D	getDn()
Field2D	getDn(Mesh mesh)
Field2D	getTemp(Mesh mesh)
boolean	hasParticles() returns true if there are more particles to sample
void	regenerate() default function to reset particle sample size, needs to be called prior to sampling source
void	sampleFluid() updates boundaries for fluid-based species
KineticMaterial.Particle	sampleParticle() returns a new particle

Methods inherited from class starfish.core.source.Source

getMaterial, getName, start, update

Methods inherited from class java.lang.Object

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

Field Detail

dn

protected FieldCollection2D dn

temp

protected FieldCollection2D temp

i_sample

protected int i_sample

j_sample

protected int j_sample

sample_mesh

protected Mesh sample_mesh

num_rem

protected double num_rem

Constructor Detail

VolumeSource

public VolumeSource(java.lang.String name,
                    Material source_mat)

Parameters:

name -

source_mat -

Method Detail

getDn

public FieldCollection2D getDn()

Returns:

getDn

public Field2D getDn(Mesh mesh)

Parameters:

mesh -

Returns:

getTemp

public Field2D getTemp(Mesh mesh)

Parameters:

mesh -

Returns:

sampleParticle

public KineticMaterial.Particle sampleParticle()

Description copied from class: Source

returns a new particle

Specified by:

sampleParticle in class Source

Returns:

hasParticles

public boolean hasParticles()

Description copied from class: Source

returns true if there are more particles to sample

Overrides:

hasParticles in class Source

Returns:

regenerate

public void regenerate()

Description copied from class: Source

default function to reset particle sample size, needs to be called prior to sampling source

Overrides:

regenerate in class Source

sampleFluid

public void sampleFluid()

Description copied from class: Source

updates boundaries for fluid-based species

Specified by:

sampleFluid in class Source

clearDn

public void clearDn()