Cantera/Extending C API - Revision history

Admin: /* Call New Method from Python Classes */

2017-04-17T08:57:57Z

Call New Method from Python Classes

← Older revision		Revision as of 08:57, 17 April 2017
Line 234:		Line 234:
	</source>		</source>

	~~[[Category:Cantera]]~~
			=Flags=

			{{CanteraFlag}}

Admin: moved Cantera Extending C API to Cantera/Extending C API

2014-01-28T20:40:21Z

moved Cantera Extending C API to Cantera/Extending C API

← Older revision

Revision as of 20:40, 28 January 2014

Admin: /* Call New Method from Python Classes */

2014-01-28T20:40:10Z

Call New Method from Python Classes

← Older revision		Revision as of 20:40, 28 January 2014
Line 214:		Line 214:

	<source lang="python">		<source lang="python">
			# First, initialize a reactor with surface kinetics
	z = importPhase('GasSurfaceMech.xml','gas')		z = importPhase('GasSurfaceMech.xml','gas')
	surf = importInterface('GasSurfaceMech.xml','catSurf',[z])		surf = importInterface('GasSurfaceMech.xml','catSurf',[z])
Line 219:		Line 220:
	r=Reactor(z)		r=Reactor(z)

			# Add a single wall and remove it
	w1 = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])		w1 = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])
	r.removeWalls()		r.removeWalls()

			# Add multiple walls and remove all of them
	w2 = Wall(left=env,right=r,A=2.0,kinetics=[None,surf])		w2 = Wall(left=env,right=r,A=2.0,kinetics=[None,surf])
	w3 = Wall(left=env,right=r,A=3.0,kinetics=[None,surf])		w3 = Wall(left=env,right=r,A=3.0,kinetics=[None,surf])

Admin: /* Call New Method from Python Classes */

2014-01-28T20:39:36Z

Call New Method from Python Classes

← Older revision		Revision as of 20:39, 28 January 2014
Line 214:		Line 214:

	<source lang="python">		<source lang="python">
	~~surf = importInterface('Curran3B_17-Jun.xml','catSurf',[z])~~		z = importPhase('GasSurfaceMech.xml','gas')
	z = importPhase('~~Curran3B_17-Jun~~.xml','gas')		surf = importInterface('GasSurfaceMech.xml','catSurf',[z])
	surf = importInterface('~~Curran3B_17-Jun~~.xml','catSurf',[z])
	env=Reservoir(Air())		env=Reservoir(Air())
	r=Reactor(z)		r=Reactor(z)

Admin: /* Call New Method from Python Classes */

2014-01-28T20:38:45Z

Call New Method from Python Classes

← Older revision		Revision as of 20:38, 28 January 2014
Line 211:		Line 211:
	</pre>		</pre>

	We can test the new functionality with a simple test script:		We can test the new functionality with a simple test script in Python:

	<~~pre~~>		<source lang="python">
	surf = importInterface('Curran3B_17-Jun.xml','catSurf',[z])		surf = importInterface('Curran3B_17-Jun.xml','catSurf',[z])
	z = importPhase('Curran3B_17-Jun.xml','gas')		z = importPhase('Curran3B_17-Jun.xml','gas')
Line 230:		Line 230:
	# This should be 0		# This should be 0
	print len(r._walls)		print len(r._walls)
	</~~pre~~>		</source>

	[[Category:Cantera]]		[[Category:Cantera]]

Admin: /* Call New Method from Python Classes */

2014-01-28T20:37:54Z

Call New Method from Python Classes

← Older revision		Revision as of 20:37, 28 January 2014
Line 220:		Line 220:
	r=Reactor(z)		r=Reactor(z)

	w = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])		w1 = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])
	r.removeWalls()		r.removeWalls()

	w = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])		w2 = Wall(left=env,right=r,A=2.0,kinetics=[None,surf])
	~~r.removeWalls()~~		w3 = Wall(left=env,right=r,A=3.0,kinetics=[None,surf])
			w4 = Wall(left=env,right=r,A=4.0,kinetics=[None,surf])
	w = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])
	~~r.removeWalls()~~

	w = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])
	r.removeWalls()		r.removeWalls()

Admin at 00:03, 28 August 2013

2013-08-28T00:03:34Z

← Older revision		Revision as of 00:03, 28 August 2013
Line 235:		Line 235:
	print len(r._walls)		print len(r._walls)
	</pre>		</pre>

			[[Category:Cantera]]

Admin at 00:03, 28 August 2013

2013-08-28T00:03:19Z

← Older revision		Revision as of 00:03, 28 August 2013
Line 2:		Line 2:

	To illustrate this procedure, I'll be adding a method to Cantera's ReactorBase class to remove all of the walls in a reactor. This article covers the following steps:		To illustrate this procedure, I'll be adding a method to Cantera's ReactorBase class to remove all of the walls in a reactor. This article covers the following steps:
	* Adding a C++ function to the ReactorBase object		* Adding a C++ function to the ReactorBase object (via <code>/path/to/cantera/src/zeroD/ReactorBase.cpp</code> and <code>/path/to/cantera/include/cantera/zeroD/ReactorBase.h</code>)
	* Extending Cantera's C API to include the new function		* Extending Cantera's C API to include the new function (via <code>/path/to/cantera/src/clib/ctreactor.{cpp,h}</code>)
	* Extending Cantera's Python-C interface to utilize the new function		* Extending Cantera's Python-C interface to utilize the new function (via <code>/path/to/cantera/src/python/{ctreactor_methods.cpp,methods.h}</code>)
	* Calling the method from Python		* Calling the new method from Cantera's Python classes (via <code>/path/to/cantera/interfaces/python/Cantera/Reactor.py</code>)



	=Add New C++ Method=		=Add New C++ Method=

			==C++ Code First==

	I'll add the following two methods to ReactorBase.cpp, to allow me to either remove a specific wall, or remove all walls:		I'll add the following two methods to ReactorBase.cpp, to allow me to either remove a specific wall, or remove all walls:
Line 15:		Line 19:
	--- ReactorBase.cpp (revision 2)		--- ReactorBase.cpp (revision 2)
	+++ ReactorBase.cpp (working copy)		+++ ReactorBase.cpp (working copy)
	@@ -72,6 +72,30 @@		@@ -72,6 +72,36 @@
	m_nwalls++;		m_nwalls++;
	}		}
Line 30:		Line 34:
	+ }		+ }
	+ }		+ }
			+ m_nwalls--;
	+}		+}
	+		+
	+void ReactorBase::removeWalls()		+void ReactorBase::removeWalls()
	+{		+{
	+ ~~vector_int::iterator iL =~~ m_lr.~~begin~~();		+ m_lr.clear();
	+ ~~for( std::vector<Wall*>::iterator iW =~~ m_wall.~~begin~~();		+ m_wall.clear();
	+ ~~iW !~~= ~~m_wall.end();~~		+ m_nwalls = 0;
	~~+ ++iW, ++iL ) {~~
	~~+ m_wall.erase(iW);~~
	~~+ m_lr.erase(iL)~~;
	~~+ }~~
	+}		+}
	+		+
Line 48:		Line 49:
	</pre>		</pre>

	~~and modify~~ the ReactorBase header file as follows:		==Header File Next==

			Modify the ReactorBase header file as follows:

	<pre>		<pre>
Line 66:		Line 69:
	</pre>		</pre>

	Once you've added these changes, ~~compile~~ Cantera ~~(see~~ the [[Cantera2]] page ~~for my~~ scons configure/build script.)		==Recompile==

			Once you've added these changes, recompile Cantera. If you're using my scons configure/build script from the [[Cantera2]] page, you'll just follow the instructions - delete cantera.conf, and re-run the scons configure/build script.



	=Extend Cantera's C API to Include New Method=		=Extend Cantera's C API to Include New Method=

			==C Code First==

	Cantera uses a C-language API (application programming interface) to provide a way for non-C++ programs (Fortran, Python, Matlab, etc.) to interface with Cantera. This interface is contained in <code>/path/to/cantera/src/clib</code>.		Cantera uses a C-language API (application programming interface) to provide a way for non-C++ programs (Fortran, Python, Matlab, etc.) to interface with Cantera. This interface is contained in <code>/path/to/cantera/src/clib</code>.
Line 98:		Line 107:
	int reactornet_new()		int reactornet_new()
	</pre>		</pre>

			==Then The Header File==

	Next, add the corresponding entry to the header file:		Next, add the corresponding entry to the header file:
Line 115:		Line 126:

	Now the Cantera C API has a way to call the ReactorBase::removeWalls() function. The last step necessary to call this method from Python is to create the glue between Python and the C API.		Now the Cantera C API has a way to call the ReactorBase::removeWalls() function. The last step necessary to call this method from Python is to create the glue between Python and the C API.



	=Extend Cantera's C-Python Interface to Include New Method=		=Extend Cantera's C-Python Interface to Include New Method=

			==Modify C Glue==

	The C-Python interface glue is all contained in <code>/path/to/cantera/src/python</code>. The code utilizing the C API for reactors is in <code>ctreactor_methods.cpp</code>. A new Python method, called from C, is defined as follows:		The C-Python interface glue is all contained in <code>/path/to/cantera/src/python</code>. The code utilizing the C API for reactors is in <code>ctreactor_methods.cpp</code>. A new Python method, called from C, is defined as follows:
Line 147:		Line 162:
	</pre>		</pre>

	This defines a Python method for calling the reactor removeWalls() function. As before, we'll need to create a corresponding entry in the header file:		This defines a Python method for calling the reactor removeWalls() function.

			==Modify Header Glue==

			As before, we'll need to create a corresponding entry in the header file:

	<pre>		<pre>
Line 166:		Line 185:
	* Python method py_reactor_removeWalls() calls C (Cantera API) method reactor_removeWalls()		* Python method py_reactor_removeWalls() calls C (Cantera API) method reactor_removeWalls()
	* C (Cantera API) method reactor_removeWalls() calls C++ method ReactorBase::removeWalls()		* C (Cantera API) method reactor_removeWalls() calls C++ method ReactorBase::removeWalls()



	=Call New Method from Python Classes=		=Call New Method from Python Classes=
Line 174:		Line 195:

	<pre>		<pre>
			===================================================================
			--- interfaces/python/Cantera/Reactor.py (revision 2)
			+++ interfaces/python/Cantera/Reactor.py (working copy)
			@@ -336,6 +336,11 @@
			else:
			return self._paramid[n]

			+ def removeWalls(self):
			+ _cantera.reactor_removeWalls(self.reactor_id())
			+ self._walls = []
			+
			+
			_reactorcount = 0
			_reservoircount = 0
	</pre>		</pre>

Line 185:		Line 219:
	env=Reservoir(Air())		env=Reservoir(Air())
	r=Reactor(z)		r=Reactor(z)

	w = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])		w = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])
	r.removeWalls()		r.removeWalls()

			w = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])
			r.removeWalls()

			w = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])
			r.removeWalls()

			w = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])
			r.removeWalls()

			# This should be 0
			print len(r._walls)
	</pre>		</pre>

Admin: /* Call New Method from Python Classes */

2013-08-27T23:52:19Z

Call New Method from Python Classes

← Older revision		Revision as of 23:52, 27 August 2013
Line 174:		Line 174:

	<pre>		<pre>

	</pre>		</pre>

Admin: /* Call New Method from Python Classes */

2013-08-27T23:06:18Z

Call New Method from Python Classes

@@ Line 174: / Line 174: @@
 <pre>
 </pre>
@@ Line 199: / Line 185: @@
 r=Reactor(z)
 w = Wall(left=env,right=r,A=1.0,kinetics=[None,surf])
 </pre>