swift2.particle.AlgorithmStepLibrary.ParticleVertexIteratorTemplate Class Reference

A mini-wrapper around a string for particle iterator. More...

Inheritance diagram for swift2.particle.AlgorithmStepLibrary.ParticleVertexIteratorTemplate:

Collaboration diagram for swift2.particle.AlgorithmStepLibrary.ParticleVertexIteratorTemplate:

Public Member Functions
	__init__ (self, template)
	template: str the string containing the particle interacion iterator template
	insert (self, function)
	insert a function into the template string.

Data Fields
	template

Detailed Description

A mini-wrapper around a string for particle iterator.

Exists for convenience: adds self.insert() method, which inserts the function which the iterators are supposed to call on a particle or particle pair.

The function insertion works via string replacement. It will look for the string 'FUNCTION' to be replaced.

Definition at line 10 of file AlgorithmStepLibrary.py.

Constructor & Destructor Documentation

__init__()

swift2.particle.AlgorithmStepLibrary.ParticleVertexIteratorTemplate.__init__	(		self,
			template )

template: str the string containing the particle interacion iterator template

Definition at line 21 of file AlgorithmStepLibrary.py.

Member Function Documentation

insert()

swift2.particle.AlgorithmStepLibrary.ParticleVertexIteratorTemplate.insert	(		self,
			function )

insert a function into the template string.

Returns the particle iterator template with the function inserted.

Definition at line 29 of file AlgorithmStepLibrary.py.

References swift2.particle.AlgorithmStepLibrary.ParticleVertexIteratorTemplate.template, and swift2.particle.AlgorithmStepLibrary.ParticleCellIteratorTemplate.template.

Field Documentation

template

swift2.particle.AlgorithmStepLibrary.ParticleVertexIteratorTemplate.template

Definition at line 26 of file AlgorithmStepLibrary.py.

Referenced by swift2.particle.AlgorithmStepLibrary.ParticleVertexIteratorTemplate.insert(), and swift2.particle.AlgorithmStepLibrary.ParticleCellIteratorTemplate.insert().

---

The documentation for this class was generated from the following file:

• python/swift2/particle/AlgorithmStepLibrary.py