Return to UnderWorld main page |

PICellerator Component Codex

This is a list of components available in PICellerator.

AdaptiveVoronoi


Organisation:
VPAC and MCC
Project:
PICellerator
Location:
./PICellerator/Voronoi/src/
Project Web:
http://www.stgermainproject.org/PICellerator.html
Copyright:
Copyright (C) 2005 VPAC and Monash Cluster Computing.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:

    Description:
    ...
    Example:
    ...
    Params
    NameTypeDefaultDescription
    maxIterationsUnsignedInt3...
    Dependencies
    TypeEssentialDescriptionNameFallbackKey

    Back to top

    BackgroundParticleLayout


    Organisation:
    VPAC and MCC
    Project:
    PICellerator
    Location:
    ./PICellerator/MaterialPoints/src/
    Project Web:
    http://www.stgermainproject.org/PICellerator.html
    Copyright:
    Copyright (C) 2005 VPAC and Monash Cluster Computing.
    License:
    https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
    Parent:
    Children:

      Description:
      A particle layout which creates only 1 particle, for use in creating backgroud layers where materials are "everywhere"
      Example:
      ...
      Params
      NameTypeDefaultDescription
      Dependencies
      TypeEssentialDescriptionNameFallbackKey

      Back to top

      BuoyancyForceTerm


      Organisation:
      VPAC and MCC
      Project:
      PICellerator
      Location:
      ./PICellerator/Utils/src/
      Project Web:
      http://www.stgermainproject.org/PICellerator.html
      Copyright:
      Copyright (C) 2005 VPAC and Monash Cluster Computing.
      License:
      https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
      Parent:
      Children:

        Description:
        This adds a force term for themo-chemical convection, where the fluid is driven my both the thermal expansivity ($\alpha$) as well as the density (). Both 'alpha' and 'density' are required as parameters for each material.
        Example:
        <struct name="buoyancyForceTerm"> <param name="Type">BuoyancyForceTerm</param> <param name="ForceVector">mom_force</param> <param name="TemperatureField">TemperatureField</param> <param name="Swarm">materialPoints</param> <param name="gravity">1.0</param> </struct>
        Equation:

        Params
        NameTypeDefaultDescription
        gravityDouble0.0This corresponds to the in the equation above.
        Dependencies
        TypeEssentialDescriptionNameFallbackKey
        FeVariableNoThis is the FeVariable from which the temperature, , is calculated in the above calculation.TemperatureField

        Back to top

        BuoyancyForceTermThermoChem


        Organisation:
        VPAC and MCC
        Project:
        PICellerator
        Location:
        ./PICellerator/Utils/src/
        Project Web:
        http://www.stgermainproject.org/PICellerator.html
        Copyright:
        Copyright (C) 2005 VPAC and Monash Cluster Computing.
        License:
        https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
        Parent:
        Children:

          Description:
          This adds a force term for themo-chemical convection, as found in van Keken et al, 'A comparison of methods for modelling of thermochemcical convection', JGR, 1997
          Example:
          <struct name="buoyancyForceTerm"> <param name="Type">BuoyancyForceTermThermoChem</param> <param name="ForceVector">mom_force</param> <param name="TemperatureField">TemperatureField</param> <param name="Swarm">picIntegrationPoints</param> <param name="RaT">RaT</param> <param name="RaC">RaC</param> </struct>
          Equation:

          Params
          NameTypeDefaultDescription
          RaTDouble0.0thermal Rayleigh number
          RaCDouble0.0chemical Rayleigh number
          Dependencies
          TypeEssentialDescriptionNameFallbackKey
          FeVariableNoThis is the FeVariable from which the temperature, , is calculated in the above calculation.TemperatureField

          Back to top

          CellularAutomataVoronoi


          Organisation:
          VPAC and MCC
          Project:
          PICellerator
          Location:
          ./PICellerator/Voronoi/src/
          Project Web:
          http://www.stgermainproject.org/PICellerator.html
          Copyright:
          Copyright (C) 2005 VPAC and Monash Cluster Computing.
          License:
          https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
          Parent:
          Children:

            Description:
            ...
            Example:
            PICellerator/Apps/PIC_Components/MaterialPointSwarm.xml
            Params
            NameTypeDefaultDescription
            resolutionUnsignedInt10Sets the number of discrete voronoi cells in all dimensions to be the same (orthotropic). Note if you specify individual resolutions as well then those values will override this orthotropic resolution.
            resolutionXUnsignedIntdefaultResolutionSets the number of discrete voronoi cells in the X direction.
            resolutionYUnsignedIntdefaultResolutionSets the number of discrete voronoi cells in the Y direction.
            resolutionZUnsignedIntdefaultResolutionSets the number of discrete voronoi cells in the Z direction.
            Dependencies
            TypeEssentialDescriptionNameFallbackKey

            Back to top

            CoincidentMapper


            Organisation:
            VPAC and MCC
            Project:
            PICellerator
            Location:
            ./PICellerator/MaterialPoints/src/
            Project Web:
            http://www.stgermainproject.org/PICellerator.html
            Copyright:
            Copyright (C) 2005 VPAC and Monash Cluster Computing.
            License:
            https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
            Parent:
            Children:

              Description:
              A one-to-one mapper that maps integration points to material points at the same coordinates. A simple global to local operation is performed. The weight of the integration point is dependant on the WeightCalculator of the IntegrationPointsSwarm.
              Example:
              Underworld/InputFiles/timingExamples/ExtensionNoVisuals_100x100x50.xml
              Params
              NameTypeDefaultDescription
              Dependencies
              TypeEssentialDescriptionNameFallbackKey

              Back to top

              ConstantWeights


              Organisation:
              VPAC and MCC
              Project:
              PICellerator
              Location:
              ./PICellerator/Weights/src/
              Project Web:
              http://www.stgermainproject.org/PICellerator.html
              Copyright:
              Copyright (C) 2005 VPAC and Monash Cluster Computing.
              License:
              https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
              Children:

              Description:
              ...
              Example:
              ...
              Params
              NameTypeDefaultDescription
              Dependencies
              TypeEssentialDescriptionNameFallbackKey

              Back to top

              DVCWeights


              Organisation:
              MCC
              Project:
              PICellerator
              Location:
              ./PICellerator/Weights/src/
              Project Web:
              http://www.stgermainproject.org/PICellerator.html
              Copyright:
              Copyright (C) 2006 Monash Cluster Computing.
              License:
              http://www.opensource.org/licenses/bsd-license.php
              Children:

              Description:
              Calculates PIC integration weights in 3D and 2D using a Voronoi diagram. The integration points are set to the centroid of a Voronoi cell and the weight is the volume of the cell.
              Params
              NameTypeDefaultDescription
              resolutionInt10A default resolution in every direction for the voronio mesh. If used you don't have to specify the resolution in every dimension.
              resolutionXInt10A default resolution in X-axis for the voronio mesh.
              resolutionYInt10A default resolution in Y-axis for the voronio mesh.
              resolutionZInt10A default resolution in Z-axis for the voronio mesh.
              Dependencies
              TypeEssentialDescriptionNameFallbackKey

              Back to top

              DiscreteVoronoi


              Organisation:
              VPAC and MCC
              Project:
              PICellerator
              Location:
              ./PICellerator/Voronoi/src/
              Project Web:
              http://www.stgermainproject.org/PICellerator.html
              Copyright:
              Copyright (C) 2005 VPAC and Monash Cluster Computing.
              License:
              https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
              Parent:
              Stg_Component
              Description:
              ...
              Example:
              ...
              Params
              NameTypeDefaultDescription
              dimUnsignedInt0...
              Dependencies
              TypeEssentialDescriptionNameFallbackKey

              Back to top

              DiscreteVoronoiRemove


              Organisation:
              VPAC and MCC
              Project:
              PICellerator
              Location:
              ./PICellerator/PopulationControl/src/
              Project Web:
              http://www.stgermainproject.org/PICellerator.html
              Copyright:
              Copyright (C) 2005 VPAC and Monash Cluster Computing.
              License:
              https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
              Parent:
              Children:

                Description:
                ...
                Example:
                ...
                Params
                NameTypeDefaultDescription
                Dependencies
                TypeEssentialDescriptionNameFallbackKey
                DiscreteVoronoiTrue...DiscreteVoronoi

                Back to top

                DiscreteVoronoiSplitting


                Organisation:
                VPAC and MCC
                Project:
                PICellerator
                Location:
                ./PICellerator/PopulationControl/src/
                Project Web:
                http://www.stgermainproject.org/PICellerator.html
                Copyright:
                Copyright (C) 2005 VPAC and Monash Cluster Computing.
                License:
                https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                Children:

                  Description:
                  ...
                  Example:
                  ...
                  Params
                  NameTypeDefaultDescription
                  Dependencies
                  TypeEssentialDescriptionNameFallbackKey
                  DiscreteVoronoiTrue...DiscreteVoronoi

                  Back to top

                  DiscreteVoronoiWeights


                  Organisation:
                  VPAC and MCC
                  Project:
                  PICellerator
                  Location:
                  ./PICellerator/Weights/src/
                  Project Web:
                  http://www.stgermainproject.org/PICellerator.html
                  Copyright:
                  Copyright (C) 2005 VPAC and Monash Cluster Computing.
                  License:
                  https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                  Children:

                    Description:
                    A component to calculate the weights for the particles in the elements by creating a discrete voronoi diagram and using the areas associated with the particles to calculate the weights.
                    Example:
                    <struct name="weights"> <param name="Type">DiscreteVoronoiWeights</param> <param name="DiscreteVoronoi">discreteVoronoi</param> </struct>
                    Params
                    NameTypeDefaultDescription
                    Dependencies
                    TypeEssentialDescriptionNameFallbackKey
                    DiscreteVoronoiTrueThe Discrete Voronoi component to use to work out the areas associated with the particles.DiscreteVoronoi

                    Back to top

                    EscapedRoutine


                    Organisation:
                    VPAC and MCC
                    Project:
                    PICellerator
                    Location:
                    ./PICellerator/PopulationControl/src/
                    Project Web:
                    http://www.stgermainproject.org/PICellerator.html
                    Copyright:
                    Copyright (C) 2005 VPAC and Monash Cluster Computing.
                    License:
                    https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                    Parent:
                    Stg_Component
                    Children:

                      Description:
                      ...
                      Example:
                      ...
                      Params
                      NameTypeDefaultDescription
                      dimUnsignedInt0...
                      particlesToRemoveDeltaUnsignedInt20...
                      Dependencies
                      TypeEssentialDescriptionNameFallbackKey

                      Back to top

                      GaussMapper


                      Organisation:
                      VPAC and MCC
                      Project:
                      PICellerator
                      Location:
                      ./PICellerator/MaterialPoints/src/
                      Project Web:
                      http://www.stgermainproject.org/PICellerator.html
                      Copyright:
                      Copyright (C) 2005 VPAC and Monash Cluster Computing.
                      License:
                      https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                      Parent:
                      Children:

                        Description:
                        A special one-to-one mapper designed for IntegrationPointsSwarms that uses a GaussParticleLayout. Because you may still want to use a simple single-cell, 4-gauss point conservative option for perfect weights and local coord calculation, this mapper allow you to map IntegrationPoints to a signle MaterialPoint. The MaterialPointsSwarm will most likely be using a BackgroundParticleLayout.
                        Example:
                        Underworld/GaussSwarm.xml
                        Params
                        NameTypeDefaultDescription
                        Dependencies
                        TypeEssentialDescriptionNameFallbackKey

                        Back to top

                        IPMapper


                        Organisation:
                        VPAC MCC
                        Project:
                        PICellerator
                        Project Web:
                        http://www.stgermainproject.org/PICellerator.html
                        Copyright:
                        Copyright (C) 2005 VPAC Monash Cluster Computing.
                        License:
                        https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicensehttp://www.opensource.org/licenses/bsd-license.php
                        Parent:
                        Stg_Component
                        Description:
                        ...
                        Example:
                        ...
                        Params
                        NameTypeDefaultDescription
                        Dependencies
                        TypeEssentialDescriptionNameFallbackKey
                        MaterialPointsMaterialPoints...MaterialPoints

                        Back to top

                        IntegrationPointMapper


                        Organisation:
                        VPAC and MCC
                        Project:
                        PICellerator
                        Location:
                        ./PICellerator/MaterialPoints/src/
                        Project Web:
                        http://www.stgermainproject.org/PICellerator.html
                        Copyright:
                        Copyright (C) 2005 VPAC and Monash Cluster Computing.
                        License:
                        https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                        Parent:
                        Stg_Component
                        Description:
                        ...
                        Example:
                        ...
                        Params
                        NameTypeDefaultDescription
                        Dependencies
                        TypeEssentialDescriptionNameFallbackKey
                        IntegrationPointsSwarmTrue...IntegrationPointsSwarm

                        Back to top

                        IntegrationPointsSwarm


                        Organisation:
                        VPAC and MCC
                        Project:
                        PICellerator
                        Location:
                        ./PICellerator/MaterialPoints/src/
                        Project Web:
                        http://www.stgermainproject.org/PICellerator.html
                        Copyright:
                        Copyright (C) 2005 VPAC and Monash Cluster Computing.
                        License:
                        https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                        Parent:
                        Children:

                          Description:
                          A specific swarm used for integration which is "aware" of the materials used. A mapper relationship links it with the physical material swarm(s) of which can actually be advected.
                          Example:
                          ...
                          Params
                          NameTypeDefaultDescription
                          recalculateWeightsBoolTrueWhether weights should be recalculated at every timestep
                          Dependencies
                          TypeEssentialDescriptionNameFallbackKey
                          FeMeshTrueThe mesh this swarm exists in.FeMesh
                          TimeIntegratorTrueThis is for particle updatesTimeIntegrator
                          WeightsCalculatorFalseCalculates each IntegrationPoint's weight at every timestep. If the particle layout is a generally needed unless you are using a gauss layout which will set the weight for you.WeightsCalculator
                          IntegrationPointMapperTrueMaps these IntegrationPoints to MaterialPointsSwarm(s). The mapper type determines the method which the points are mapped.IntegrationPointMapper

                          Back to top

                          IterativeWeights


                          Organisation:
                          VPAC and MCC
                          Project:
                          PICellerator
                          Location:
                          ./PICellerator/Weights/src/
                          Project Web:
                          http://www.stgermainproject.org/PICellerator.html
                          Copyright:
                          Copyright (C) 2005 VPAC and Monash Cluster Computing.
                          License:
                          https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                          Parent:
                          Children:

                            Description:
                            ...
                            Example:
                            ...
                            Params
                            NameTypeDefaultDescription
                            maxIterationsUnsignedInt10...
                            toleranceDouble0.01...
                            alphaDouble0.8...
                            Dependencies
                            TypeEssentialDescriptionNameFallbackKey
                            WeightsCalculatorNo...InitialWeights

                            Back to top

                            ManyToOneMapper


                            Organisation:
                            VPAC and MCC
                            Project:
                            PICellerator
                            Location:
                            ./PICellerator/MaterialPoints/src/
                            Project Web:
                            http://www.stgermainproject.org/PICellerator.html
                            Copyright:
                            Copyright (C) 2005 VPAC and Monash Cluster Computing.
                            License:
                            https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                            Children:

                              Description:
                              Maps many MaterialPointsSwarms to one IntegrationPointsSwarm
                              Example:
                              n/a
                              Params
                              NameTypeDefaultDescription
                              Dependencies
                              TypeEssentialDescriptionNameFallbackKey
                              MaterialPointsSwarmTrueThe list of material points to be mapped.MaterialPointsSwarm

                              Back to top

                              MappedParticleLayout


                              Organisation:
                              VPAC and MCC
                              Project:
                              PICellerator
                              Location:
                              ./PICellerator/MaterialPoints/src/
                              Project Web:
                              http://www.stgermainproject.org/PICellerator.html
                              Copyright:
                              Copyright (C) 2005 VPAC and Monash Cluster Computing.
                              License:
                              https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                              Parent:
                              Children:

                                Description:
                                Special particle layout for IntegrationPointsSwarms. Indicates that the particle layout will be determined by a IntegrationPointMapper.
                                Example:
                                ...
                                Params
                                NameTypeDefaultDescription
                                Dependencies
                                TypeEssentialDescriptionNameFallbackKey

                                Back to top

                                Material


                                Organisation:
                                VPAC and MCC
                                Project:
                                PICellerator
                                Location:
                                ./PICellerator/MaterialPoints/src/
                                Project Web:
                                http://www.stgermainproject.org/PICellerator.html
                                Copyright:
                                Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                License:
                                https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                Parent:
                                Stg_Component
                                Children:

                                Description:
                                Instances of the Material component represent a physical material. Its parameters are dynamic, each corresponding to a material property which defines its mathematical behaviour.
                                Example:
                                ./PICellerator/Apps/RayleighTaylor/RayTay_Example.xml
                                Params
                                NameTypeDefaultDescription
                                Dependencies
                                TypeEssentialDescriptionNameFallbackKey
                                Stg_ShapeTrueA shape which defines its location and dimensions within the problem domainShape

                                Back to top

                                MaterialFeVariable


                                Organisation:
                                VPAC and MCC
                                Project:
                                PICellerator
                                Location:
                                ./PICellerator/MaterialPoints/src/
                                Project Web:
                                http://www.stgermainproject.org/PICellerator.html
                                Copyright:
                                Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                License:
                                https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                Children:

                                  Description:
                                  Extends on ParticleFeVariable by adding material properties (and an IntegrationPointsSwarm)
                                  Example:
                                  ./Underworld/InputFiles/ExtensionFMM3D.xml
                                  Params
                                  NameTypeDefaultDescription
                                  Dependencies
                                  TypeEssentialDescriptionNameFallbackKey
                                  MaterialTrueThe material properties to be applied Material

                                  Back to top

                                  MaterialPointsSwarm


                                  Organisation:
                                  VPAC and MCC
                                  Project:
                                  PICellerator
                                  Location:
                                  ./PICellerator/MaterialPoints/src/
                                  Project Web:
                                  http://www.stgermainproject.org/PICellerator.html
                                  Copyright:
                                  Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                  License:
                                  https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                  Parent:
                                  Children:

                                    Description:
                                    Represents a set of points which track materials in the domain. It can be advected during the simulation and can be population controlled for load balancing purposes.
                                    Example:
                                    ...
                                    Params
                                    NameTypeDefaultDescription
                                    Dependencies
                                    TypeEssentialDescriptionNameFallbackKey
                                    FeMeshTrueThe mesh this swarm exists in.FeMesh
                                    RemovalRoutineFalsePopulation control routine that reduces particles in a cell when there is too many.RemovalRoutine
                                    SplittingRoutineFalsePopulation control routine that increases the number of particles in a cell when there is not enough. SplittingRoutine
                                    EscapedRoutineFalsePopulation control routine which removes particles which have escaped the mesh domainEscapedRoutine
                                    MaterialFalseIf you set a material in a MaterialPointsSwarm, the entire swarm's particle will be located within the material's bounds and will only consist of particle of that material. Otherwise, the swarm is spread across the entire domain and will be assigned materials according to the all the materials. Material

                                    Back to top

                                    MaterialSwarm


                                    Organisation:
                                    VPAC MCC
                                    Project:
                                    PICellerator
                                    Project Web:
                                    http://www.stgermainproject.org/PICellerator.html
                                    Copyright:
                                    Copyright (C) 2005 VPAC Monash Cluster Computing.
                                    License:
                                    https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicensehttp://www.opensource.org/licenses/bsd-license.php
                                    Parent:
                                    Children:

                                      Description:
                                      ...
                                      Example:
                                      ...
                                      Params
                                      NameTypeDefaultDescription
                                      ParticleTypeStringMaterialParticle...
                                      Dependencies
                                      TypeEssentialDescriptionNameFallbackKey

                                      Back to top

                                      MaterialSwarmVariable


                                      Organisation:
                                      VPAC and MCC
                                      Project:
                                      PICellerator
                                      Location:
                                      ./PICellerator/Utils/src/
                                      Project Web:
                                      http://www.stgermainproject.org/PICellerator.html
                                      Copyright:
                                      Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                      License:
                                      https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                      Parent:
                                      Children:

                                        Description:
                                        Creates a swarm variable from a value stored on each material. This means that the degrees of freedom for the SwarmVariable aren't extra data on the particles in the swarm but stored only once per material.
                                        Example:
                                        ...
                                        Params
                                        NameTypeDefaultDescription
                                        Dependencies
                                        TypeEssentialDescriptionNameFallbackKey

                                        Back to top

                                        MomentBalanceWeights


                                        Organisation:
                                        VPAC and MCC
                                        Project:
                                        PICellerator
                                        Location:
                                        ./PICellerator/Weights/src/
                                        Project Web:
                                        http://www.stgermainproject.org/PICellerator.html
                                        Copyright:
                                        Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                        License:
                                        https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                        Children:

                                          Description:
                                          This assumes the weights are uniform in the quadrants of the elements and then ascertains what those weights are using the linear constraints.
                                          Example:
                                          <struct name="weights"> <param name="Type">MomentBalanceWeights</param> <param name="BackupWeights">constantWeights</param> </struct>
                                          Params
                                          NameTypeDefaultDescription
                                          Dependencies
                                          TypeEssentialDescriptionNameFallbackKey
                                          WeightsCalculatorNoAnother weights routine to use if the Moment Balence one fails. This will be necessary if no particles are found in one of the quadrants of an element.BackupWeights

                                          Back to top

                                          OneToOneMapper


                                          Organisation:
                                          VPAC and MCC
                                          Project:
                                          PICellerator
                                          Location:
                                          ./PICellerator/MaterialPoints/src/
                                          Project Web:
                                          http://www.stgermainproject.org/PICellerator.html
                                          Copyright:
                                          Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                          License:
                                          https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                          Description:
                                          An abstract mapper which will yield one-to-one mapping of integration points to material points.
                                          Example:
                                          n/a
                                          Params
                                          NameTypeDefaultDescription
                                          Dependencies
                                          TypeEssentialDescriptionNameFallbackKey
                                          MaterialPointsSwarmTrueThe list of material points to be mapped.MaterialPointsSwarm

                                          Back to top

                                          PCDVC


                                          Organisation:
                                          MCC
                                          Project:
                                          PICellerator
                                          Location:
                                          ./PICellerator/Utils/src/
                                          Project Web:
                                          http://www.stgermainproject.org/PICellerator.html
                                          Copyright:
                                          Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                          License:
                                          https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                          Parent:
                                          Children:

                                            Description:
                                            Calculates PIC integration weights and handles Population Control in 3D and 2D using a Voronoi diagram. The integration points are set to the centroid of a Voronoi cell and the weight is the volume of the cell.
                                            Example:
                                            PICellerator/MaterialPointSwarm.xml
                                            Params
                                            NameTypeDefaultDescription
                                            upperTDouble25Threshold percentage, of weight, where voronio cell will be flaged for a split into 2 voronio cells
                                            lowerTDouble0.6Threshold percentage, of weight, where voronio cells will be flaged for deletion
                                            maxDeletionsUnsignedInt2Sets the maximum number of deletions that can occur
                                            maxSplitsUnsignedInt3Sets the maximum number of deletions that can occur
                                            splitInInterfaceCellsBoolFalsePerform split operations in cells where multiple material point swarms exist. Warning could cause numerical diffusion, also consider if you have visualisation swarms or passive tracer swarm and how they are defined
                                            resolutionUnsignedInt10Discrete Voronoi resolution in all dimensions, or you can specified individually using resolutionX/Y/Z
                                            resolutionXUnsignedIntdefaultResolutionDiscrete Voronoi resolution in X axis
                                            resolutionYUnsignedIntdefaultResolutionDiscrete Voronoi resolution in Y axis
                                            resolutionZUnsignedIntdefaultResolutionDiscrete Voronoi resolution in Z axis
                                            InflowUnsignedIntFalseSwitches the Inflow flag on
                                            ThresholdDouble0.8Population threshold trigger for cells in an inflow problem
                                            CentPosRatioDouble0.01Centroid position trigger as a ratio of distance of data to centroid position over FEm cell width

                                            Back to top

                                            PICelleratorContext


                                            Organisation:
                                            VPAC and MCC
                                            Project:
                                            PICellerator
                                            Location:
                                            ./PICellerator/MaterialPoints/src/
                                            Project Web:
                                            http://www.stgermainproject.org/PICellerator.html
                                            Copyright:
                                            Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                            License:
                                            https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                            Children:

                                            Description:
                                            ...
                                            Example:
                                            ...
                                            Params
                                            NameTypeDefaultDescription
                                            Dependencies
                                            TypeEssentialDescriptionNameFallbackKey

                                            Back to top

                                            ParticleFeVariable


                                            Organisation:
                                            VPAC and MCC
                                            Project:
                                            PICellerator
                                            Location:
                                            ./PICellerator/MaterialPoints/src/
                                            Project Web:
                                            http://www.stgermainproject.org/PICellerator.html
                                            Copyright:
                                            Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                            License:
                                            https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                            Parent:
                                            Description:
                                            ...
                                            Example:
                                            ...
                                            Params
                                            NameTypeDefaultDescription
                                            Dependencies
                                            TypeEssentialDescriptionNameFallbackKey
                                            SwarmTrue...Swarm
                                            FiniteElementContextTrue...Context
                                            FeMeshTrue...Mesh

                                            Back to top

                                            PeriodicBoundariesManager


                                            Organisation:
                                            VPAC and MCC
                                            Project:
                                            PICellerator
                                            Location:
                                            ./PICellerator/MaterialPoints/src/
                                            Project Web:
                                            http://www.stgermainproject.org/PICellerator.html
                                            Copyright:
                                            Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                            License:
                                            https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                            Parent:
                                            Stg_Component
                                            Children:

                                              Description:
                                              The PeriodicBoundariesManager sets up periodic boundaries and changes particle coordinates when particles cross periodic boundaries
                                              Example:
                                              Underworld/InputFiles/VariableConditions/velocityBCs.shear2D.xml
                                              Params
                                              NameTypeDefaultDescription
                                              PeriodicBoundariesListA list of strings defining which boundaries are periodic (eg. I_AXIS, J_AXIS)
                                              Dependencies
                                              TypeEssentialDescriptionNameFallbackKey
                                              MeshTrueThe mesh that the swarm exists in, and which defines the boundariesmesh
                                              SwarmTrueThe swarm of particles that the PeriodicBoundariesManager must move if they cross a periodic boundarySwarm

                                              Back to top

                                              RemovalRoutine


                                              Organisation:
                                              VPAC and MCC
                                              Project:
                                              PICellerator
                                              Location:
                                              ./PICellerator/PopulationControl/src/
                                              Project Web:
                                              http://www.stgermainproject.org/PICellerator.html
                                              Copyright:
                                              Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                              License:
                                              https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                              Parent:
                                              Stg_Component
                                              Description:
                                              ...
                                              Example:
                                              ...
                                              Params
                                              NameTypeDefaultDescription
                                              dimUnsignedInt0...
                                              idealParticleCountUnsignedInt0...
                                              maxParticlesPerCellUnsignedIntidealParticleCount...
                                              particlesToRemoveDeltaUnsignedInt20...
                                              Dependencies
                                              TypeEssentialDescriptionNameFallbackKey

                                              Back to top

                                              ReseedSplitting


                                              Organisation:
                                              VPAC and MCC
                                              Project:
                                              PICellerator
                                              Location:
                                              ./PICellerator/PopulationControl/src/
                                              Project Web:
                                              http://www.stgermainproject.org/PICellerator.html
                                              Copyright:
                                              Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                              License:
                                              https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                              Children:

                                                Description:
                                                ...
                                                Example:
                                                ...
                                                Params
                                                NameTypeDefaultDescription
                                                Dependencies
                                                TypeEssentialDescriptionNameFallbackKey

                                                Back to top

                                                SingleMaterialMapper


                                                Organisation:
                                                VPAC MCC
                                                Project:
                                                PICellerator
                                                Project Web:
                                                http://www.stgermainproject.org/PICellerator.html
                                                Copyright:
                                                Copyright (C) 2005 VPAC Monash Cluster Computing.
                                                License:
                                                https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicensehttp://www.opensource.org/licenses/bsd-license.php
                                                Parent:
                                                Children:

                                                  Description:
                                                  ...
                                                  Example:
                                                  ...
                                                  Params
                                                  NameTypeDefaultDescription
                                                  Dependencies
                                                  TypeEssentialDescriptionNameFallbackKey

                                                  Back to top

                                                  SplittingRoutine


                                                  Organisation:
                                                  VPAC and MCC
                                                  Project:
                                                  PICellerator
                                                  Location:
                                                  ./PICellerator/PopulationControl/src/
                                                  Project Web:
                                                  http://www.stgermainproject.org/PICellerator.html
                                                  Copyright:
                                                  Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                                  License:
                                                  https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                                  Parent:
                                                  Stg_Component
                                                  Description:
                                                  ...
                                                  Example:
                                                  ...
                                                  Params
                                                  NameTypeDefaultDescription
                                                  dimUnsignedInt0...
                                                  idealParticleCountUnsignedInt0...
                                                  minParticlesPerCellUnsignedIntidealParticleCount...
                                                  Dependencies
                                                  TypeEssentialDescriptionNameFallbackKey

                                                  Back to top

                                                  SwarmAdvector


                                                  Organisation:
                                                  VPAC and MCC
                                                  Project:
                                                  PICellerator
                                                  Location:
                                                  ./PICellerator/MaterialPoints/src/
                                                  Project Web:
                                                  http://www.stgermainproject.org/PICellerator.html
                                                  Copyright:
                                                  Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                                  License:
                                                  https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                                  Parent:
                                                  Children:

                                                    Description:
                                                    A component which moves particles according to a velocity field each timestep.
                                                    Example:
                                                    <struct name="materialPointsAdvector"> <param name="Type">SwarmAdvector</param> <param name="Swarm">materialPointsSwarm</param> <param name="TimeIntegrator">timeIntegrator</param> <param name="VelocityField">VelocityField</param> </struct>
                                                    Params
                                                    NameTypeDefaultDescription
                                                    Dependencies
                                                    TypeEssentialDescriptionNameFallbackKey
                                                    FeVariableTrueThe Velocity Field which advects the particles around.VelocityField
                                                    SwarmTrueThe swarm of particles to be advected.Swarm
                                                    PeriodicBoundariesManagerNoIf the model has periodic boundary conditions, there my be Periodic Boundary conditions manager which controls how the particles go around the periodic boundaries. If no Periodic BCs Manager is given, and the SwarmAdvector discovers that the mesh is periodic, it will create one for you.PeriodicBCsManager

                                                    Back to top

                                                    SwarmAdvectorD


                                                    Organisation:
                                                    VPAC and MCC
                                                    Project:
                                                    PICellerator
                                                    Location:
                                                    ./PICellerator/MaterialPoints/src/
                                                    Project Web:
                                                    http://www.stgermainproject.org/PICellerator.html
                                                    Copyright:
                                                    Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                                    License:
                                                    https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                                    Parent:
                                                    Children:

                                                      Description:
                                                      Special advector that does not advect particles in the z direction
                                                      Example:
                                                      ...
                                                      Params
                                                      NameTypeDefaultDescription
                                                      Dependencies
                                                      TypeEssentialDescriptionNameFallbackKey
                                                      FeVariableTrue...VelocityField
                                                      SwarmTrue...Swarm
                                                      PeriodicBoundariesManagerNo...PeriodicBCsManager

                                                      Back to top

                                                      SwarmVariableField


                                                      Organisation:
                                                      VPAC and MCC
                                                      Project:
                                                      PICellerator
                                                      Location:
                                                      ./PICellerator/MaterialPoints/src/
                                                      Project Web:
                                                      http://www.stgermainproject.org/PICellerator.html
                                                      Copyright:
                                                      Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                                      License:
                                                      https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                                      Children:

                                                        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.
                                                        Example:
                                                        n/a
                                                        Params
                                                        NameTypeDefaultDescription
                                                        swarmVariableString""Textual name of the swarm variable which will be interpolated onto the mesh
                                                        Dependencies
                                                        TypeEssentialDescriptionNameFallbackKey
                                                        MaterialPointsSwarmTrueMaterial swarm from which the swarm variable is to be obtained.MaterialSwarm
                                                        IntegrationPointsSwarmTrueIntegration 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.Swarm
                                                        FiniteElementContextTrueStGermain context, to be passed to the parent class in order to create a force vector on which to store the material values by node.context

                                                        Back to top

                                                        VolumeWeights


                                                        Organisation:
                                                        VPAC and MCC
                                                        Project:
                                                        PICellerator
                                                        Location:
                                                        ./PICellerator/Weights/src/
                                                        Project Web:
                                                        http://www.stgermainproject.org/PICellerator.html
                                                        Copyright:
                                                        Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                                        License:
                                                        https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                                        Children:

                                                          Description:
                                                          Calculates PIC integration weights based on cell volumes
                                                          Example:
                                                          PICellerator/Apps/src/MaterialPointSwarm-test1.xml
                                                          Params
                                                          NameTypeDefaultDescription
                                                          Dependencies
                                                          TypeEssentialDescriptionNameFallbackKey
                                                          Stg_ShapeTrueThe overall shapeShape
                                                          FeMeshTrueThe mesh - assumed to be regularMesh

                                                          Back to top

                                                          WeightsCalculator


                                                          Organisation:
                                                          VPAC and MCC
                                                          Project:
                                                          PICellerator
                                                          Location:
                                                          ./PICellerator/Weights/src/
                                                          Project Web:
                                                          http://www.stgermainproject.org/PICellerator.html
                                                          Copyright:
                                                          Copyright (C) 2005 VPAC and Monash Cluster Computing.
                                                          License:
                                                          https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php
                                                          Parent:
                                                          Stg_Component
                                                          Description:
                                                          A WeightsCalculator is a component that allows PIC integration weights to calculated in different ways. Current methods include VolumeWeights, ConstantWeights, DiscreteVoronoiWeights, DVCWeights, IterativeWeights and MomentBalanceWeights.
                                                          Example:
                                                          Underworld/InputFiles/timingExamples/ExtensionNoVisuals_100x100x50.xml
                                                          Params
                                                          NameTypeDefaultDescription
                                                          dimUnsignedInt0The number of dimensions we are working in
                                                          Dependencies
                                                          TypeEssentialDescriptionNameFallbackKey

                                                          Back to top