Changes between Version 2 and Version 3 of UniformRegions

Timestamp:

05/04/11 16:31:29 (14 years ago)

Author:

Brandon Shroyer

Comment:

—

UniformRegions

@@ -3 +3 @@
 = Uniform Regions =
 
-As its name implies, the {{{UniformRegion}}} object defines a region where the hydrodynamic variables are constant.  The region itself is defined by a [wiki:Shape Shape] object passed in when the {{{UniformRegion}}} is created.  The {{{UniformRegion}}} can be used as a one-shot or it can be made ''persistent'', in which case it would be renewed before every step (i.e., by  a subroutine called in {{{beforeStep()}}}).
+== Description ==
+As its name implies, the {{{UniformRegion}}} object defines a region where the hydrodynamic variables are constant.  The region itself is defined by a [wiki:Shape Shape] object that is instantiated when {{{UniformRegion}}} is created.  The {{{UniformRegion}}} can be used as a one-shot or it can be made ''persistent'', in which case it would be renewed before every step (i.e., by  a subroutine called in {{{beforeStep()}}}).
 
 [[BR]]
 
-== Object Definitions ==
-{{{UniformRegion}}}:
+== Object API ==
+[[BR]]
+=== Definition ===
+
 {{{
-TYPE(ShapeDef), POINTER :: Shape
-REAL(KIND=qPREC), DIMENSION(:), ALLOCATABLE :: q
-INTEGER :: SubSample = 1
-LOGICAL :: PersistInBoundaries = .false.
-LOGICAL :: PersistInternal = .false.
+TYPE UniformRegion {
+    TYPE(ShapeDef), POINTER :: Shape
+    REAL(KIND=qPREC), DIMENSION(:), ALLOCATABLE :: q
+    INTEGER :: SubSample = 1
+    LOGICAL :: PersistInBoundaries = .false.
+    LOGICAL :: PersistInternal = .false.
+}
 }}}
 
@@ -26 +31 @@
 
  * ''{{{PersistInternal}}}'': Indicates whether the uniform region is persistent.  Under this option, {{{beforeStep()}}} will enforce the uniform region within a grid's [GhostZone ghost regions] as well.  By default, this option is turned off.
+[[BR]]
+=== Methods ===
+
+ * ''{{{InitUniformRegions()}}}'':
+
+ *  ''{{{ CreateUniformRegion(UniformRegion)}}}'':
+
+ * ''{{{AddUniformRegionObjToList(UniformRegionObj)}}}'':
+
+ * ''{{{RemoveUniformRegionObjFromList(UniformRegionObj)}}}'':
+
+ * ''{{{DestroyUniformRegionObject(UniformRegionObj)}}}'':
+
+ * ''{{{UniformRegionGridInit(Info)}}}'':
+
+ * ''{{{UniformRegionBeforeStep(Info)}}}'':
+
+ * ''{{{PlaceUniformRegion(Info, UniformRegion, location)}}}'':
+
 
 [[BR]]
 == How to Use this Object ==
 
-The uniform regions object contains a ShapeObject that defines where the uniform value {{{q}}} is to be applied.  The !SubSample defines how many sub cells in each direction are sampled.  If !PersistInBoundaries is true then anywhere the object overlaps with physical boundaries - the values are maintained during the simulation.
+The uniform regions object contains a [ShapeObjects Shape object] that defines where the uniform value {{{q}}} is to be applied.  The !SubSample defines how many sub cells in each direction are sampled.  If !PersistInBoundaries is true then anywhere the object overlaps with physical boundaries - the values are maintained during the simulation.
 If !PersistInternal is true then the values are maintained wherever the object exists.
 
 {{{
 SUBROUTINE ProblemModuleInit()
-  TYPE(UniformRegionDef), POINTER :: UniformRegion 
+  TYPE(UniformRegionDef), POINTER :: UniformRegion
+
   CALL CreateUniformRegion(UniformRegion) 
+
   UniformRegion%q(1:NrHydroVars)=qout(1:NrHydroVars)
   UniformRegion%q(1)=density
+
   CALL SetShapeType(UniformRegion%Shape, CIRCLE, radius)
   CALL SetShapeOrientation(UniformRegion%Shape, psi, theta, phi)
   SplitRegion%Shape%Position=position
+
   CALL SetShapeBounds(UniformRegion%Shape)
 END SUBROUTINE ProblemModuleInit
 }}}
 
-When you call CreateUniformRegion it adds the uniform region to a list and then automatically handles the initialization and the necessary boundary conditions.  There is nothing else you have to do.
+When you call {{{CreateUniformRegion()}}} it instantiates all the pointer/allocatable attributes of a {{{UniformRegion}}} object and adds it to a global list of {{{UniformRegion}}} objects. The {{{UniformRegion%q}}} array is allocated with {{{NrHydroVars}}} elements.
+
+As of revision 566, the user must manually set the values for {{{UniformRegion%q}}} (see the example above).  Configuring the {{{UniformRegion%Shape}}} object is also the user's responsibility.
+
+