Capacitor
[Distribution flow solver (radial)]

Functions
	capacitor::capacitor (MODULE *mod)
	constructor.
EXPORT int	create_capacitor (OBJECT **obj, OBJECT *parent)
	REQUIRED: allocate and initialize an object.
EXPORT int	init_capacitor (OBJECT *obj)
	Object initialization is called once after all object have been created.
EXPORT int	isa_capacitor (OBJECT *obj, char *classname)
	Allows the core to discover whether obj is a subtype of this class.
EXPORT TIMESTAMP	sync_capacitor (OBJECT *obj, TIMESTAMP t0, PASSCONFIG pass)
	Sync is called when the clock needs to advance on the bottom-up pass (PC_BOTTOMUP).

---

Function Documentation

capacitor::capacitor

(

MODULE *

mod

)

[inherited]

constructor.

Class registration is only called once to register the class with the core. Include parent class constructor (node)

Parameters:

mod

a module structure maintained by the core

Definition at line 29 of file capacitor.cpp.

References gl_publish_variable, gl_register_class, GL_THROW, PADDR, PC_BOTTOMUP, PC_POSTTOPDOWN, PC_PRETOPDOWN, PC_UNSAFE_OVERRIDE_OMIT, PHASE_A, PHASE_B, PHASE_C, PHASE_D, PHASE_N, PT_double, PT_enumeration, PT_object, and PT_set.

EXPORT int create_capacitor	(	OBJECT **	obj,
		OBJECT *	parent
	)

REQUIRED: allocate and initialize an object.

Parameters:

	obj	a pointer to a pointer of the last object in the list
	parent	a pointer to the parent of this object

Returns:

1 for a successfully created object, 0 for error

Definition at line 1013 of file capacitor.cpp.

References gl_create_object, gl_error, gl_set_parent, and OBJECTDATA.

EXPORT int init_capacitor

(

OBJECT *

obj

)

Object initialization is called once after all object have been created.

Parameters:

obj

a pointer to this object

Returns:

1 on success, 0 on error

Definition at line 1040 of file capacitor.cpp.

References GL_THROW, and OBJECTDATA.

EXPORT int isa_capacitor	(	OBJECT *	obj,
		char *	classname
	)

Allows the core to discover whether obj is a subtype of this class.

Parameters:

	obj	a pointer to this object
	classname	the name of the object the core is testing

Returns:

0 if obj is a subtype of this class

Definition at line 1095 of file capacitor.cpp.

References OBJECTDATA.

EXPORT TIMESTAMP sync_capacitor	(	OBJECT *	obj,
		TIMESTAMP	t0,
		PASSCONFIG	pass
	)

Sync is called when the clock needs to advance on the bottom-up pass (PC_BOTTOMUP).

Parameters:

	obj	the object we are sync'ing
	t0	this objects current timestamp
	pass	the current pass for this sync call

Returns:

t1, where t1>t0 on success, t1=t0 for retry, t1<t0 on failure

Definition at line 1061 of file capacitor.cpp.

References GL_THROW, OBJECTDATA, PC_BOTTOMUP, PC_POSTTOPDOWN, and PC_PRETOPDOWN.