[cig-commits] commit: changes to meta files, and also to textual name of swarm variable obtained from xml, is a primitive string, so use lower case

[Mercurial]

changeset:   96:8ceb22bb0e67
user:        DavidLee
date:        Wed May 14 05:44:12 2008 +0000
files:       MaterialPoints/src/Material.meta MaterialPoints/src/SwarmVariableField.c MaterialPoints/src/SwarmVariableField.meta
description:
changes to meta files, and also to textual name of swarm variable obtained from xml, is a primitive string, so use lower case
for first letter


diff -r 80b2838f7e04 -r 8ceb22bb0e67 MaterialPoints/src/Material.meta
--- a/MaterialPoints/src/Material.meta	Wed May 14 02:42:54 2008 +0000
+++ b/MaterialPoints/src/Material.meta	Wed May 14 05:44:12 2008 +0000
@@ -31,6 +31,6 @@ property which defines its mathematical 
 	</struct>
 
 </list>
-<param name="Example">...</param>
+<param name="Example">./PICellerator/Apps/RayleighTaylor/RayTay_Example.xml</param>
 
 </StGermainData>
diff -r 80b2838f7e04 -r 8ceb22bb0e67 MaterialPoints/src/SwarmVariableField.c
--- a/MaterialPoints/src/SwarmVariableField.c	Wed May 14 02:42:54 2008 +0000
+++ b/MaterialPoints/src/SwarmVariableField.c	Wed May 14 05:44:12 2008 +0000
@@ -175,7 +175,7 @@ void _SwarmVariableField_Construct( void
 	_ParticleFeVariable_Construct( self, cf, data );
 
 	// TODO: just get the textual name here - see gLucifer's SwarmPlotter DrawignObject 
-	self->swarmVarName = Stg_ComponentFactory_GetString( cf, self->name, "SwarmVariable", "" );
+	self->swarmVarName = Stg_ComponentFactory_GetString( cf, self->name, "swarmVariable", "" );
 	assert( swarmVar );
 
 	self->materialSwarm = Stg_ComponentFactory_ConstructByKey( cf, self->name, "MaterialSwarm", MaterialPointsSwarm, True, data );
@@ -183,9 +183,8 @@ void _SwarmVariableField_Construct( void
 	integrationSwarm = Stg_ComponentFactory_ConstructByKey( cf, self->name, "Swarm", IntegrationPointsSwarm, True, NULL );
 	assert( integrationSwarm );
 
-	/* dunno if this is the right way about getting the context... */
-	context = (FiniteElementContext*) Stg_ComponentFactory_ConstructByName( cf, "context", FiniteElementContext, True, data );
-	//context = Stg_ComponentFactory_ConstructByKey( cf, "context", FiniteElementContext, True, data );
+	context = (FiniteElementContext*) Stg_ComponentFactory_ConstructByKey( cf, self->name, "context", FiniteElementContext, True, data );
+	
 	assert( context );
 
 	_SwarmVariableField_Init( self, swarmVar, variable_Register );
@@ -203,9 +202,6 @@ void _SwarmVariableField_Build( void* sw
 	tmpName = Stg_Object_AppendSuffix( self, "DataVariable" );
 	self->dataVariable = Variable_NewScalar( tmpName,
 		       				 Variable_DataType_Double,
-						 /* this guy is NULL, & i have no idea what an igraph is,
-						  * but this arument is a pointer to the array size - 03.10.07 */
-						 //&((IGraph*)self->feMesh->topo)->remotes[MT_VERTEX]->nDomains,
 						 &nDomainVerts,
 						 NULL,
 						 (void**)&self->data,
@@ -288,7 +284,6 @@ void _SwarmVariableField_ValueAtParticle
 	SwarmVariable_ValueAt( self->swarmVar, lParticle_I, value ); /* does the copy inside this func. dave, 18.09.07 */
 }
 
-/* use the FeVariable_GetValueAtNode func. dave, 03.10.07 */
 void _SwarmVariableField_GetValueAtNode( void* swarmVariableField, Node_DomainIndex dNode_I, double* value ) {
 	FeVariable_GetValueAtNode( swarmVariableField, dNode_I, value );
 }
diff -r 80b2838f7e04 -r 8ceb22bb0e67 MaterialPoints/src/SwarmVariableField.meta
--- a/MaterialPoints/src/SwarmVariableField.meta	Wed May 14 02:42:54 2008 +0000
+++ b/MaterialPoints/src/SwarmVariableField.meta	Wed May 14 05:44:12 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">SwarmVariableField</param>
-<param name="Author">...</param>
+<param name="Author">dave lee</param>
 <param name="Organisation">VPAC and MCC</param>
 <param name="Project">PICellerator</param>
 <param name="Location">./PICellerator/MaterialPoints/src/</param>
@@ -16,11 +16,35 @@
 <param name="Description">Takes the value for a given swarm variable (the textual name of which is provided through the XML) at each particle and assigns a dof layout for the mesh (specified through the XML). The parent class then uses this swarm variable value by polymorphically calling the respective value at particle function to interpolate the swarm variable values onto the mesh nodes using the shape functions. These are then stored on the mesh using the dof layout created here.</param>
 
 <list name="Params">
+	<struct>
+		<param name="Name">swarmVariable</param>
+		<param name="Type">String</param>
+		<param name="Default">""</param>
+		<param name="Description">Textual name of the swarm variable which will be interpolated onto the mesh</param>
+	</struct>
 </list>
 
 <list name="Dependencies">
+	<struct>
+		<param name="Essential">True</param>
+		<param name="Name">MaterialSwarm</param>
+		<param name="Type">MaterialPointsSwarm</param>
+		<param name="Description">Material swarm from which the swarm variable is to be obtained.</param>
+	</struct>
+	<struct>
+		<param name="Essential">True</param>
+		<param name="Name">Swarm</param>
+		<param name="Type">IntegrationPointsSwarm</param>
+		<param name="Description">Integration swarm used to evaluate the value of the swarm variable over an element, such that these values may be added to a nodal based force vector.</param>
+	</struct>
+	<struct>
+		<param name="Essential">True</param>
+		<param name="Name">context</param>
+		<param name="Type">FiniteElementContext</param>
+		<param name="Description">StGermain context, to be passed to the parent class in order to create a force vector on which to store the material values by node.</param>
+	</struct>
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">n/a</param>
 
 </StGermainData>