Merge pull request #6051 from gassmoeller/particle_component_update

Only evaluate necessary solution components during particle property update

Author: gassmoeller

include/aspect/introspection.h

@@ -355,10 +355,34 @@ namespace aspect
       {
         ComponentMasks (const FEVariableCollection<dim> &fevs, const Introspection<dim>::ComponentIndices &indices);
 
+        /**
+         * The component mask for all velocity components.
+         */
         ComponentMask              velocities;
+
+        /**
+         * The component mask for the pressure component.
+         */
         ComponentMask              pressure;
+
+        /**
+         * The component mask for the temperature component.
+         */
         ComponentMask              temperature;
+
+        /**
+         * The component mask for each individual compositional field.
+         * The size of this vector is equal to the number of compositional fields.
+         * Each entry is a component mask that selects the component
+         * that corresponds to the respective compositional field.
+         */
         std::vector<ComponentMask> compositional_fields;
+
+        /**
+         * The component mask for all composition components.
+         * This mask selects all compositional fields.
+         */
+        ComponentMask              compositions;
       };
 
       /**

include/aspect/particle/property/composition.h

@@ -72,11 +72,10 @@ namespace aspect
           need_update () const override;
 
           /**
-           * Return which data has to be provided to update the property.
-           * The pressure and temperature need the values of their variables.
+           * @copydoc aspect::Particle::Property::Interface::get_update_flags()
            */
           UpdateFlags
-          get_needed_update_flags () const override;
+          get_update_flags (const unsigned int component) const override;
 
           /**
            * Set up the information about the names and number of components

include/aspect/particle/property/cpo_bingham_average.h

@@ -113,11 +113,10 @@ namespace aspect
           need_update () const override;
 
           /**
-           * Return which data has to be provided to update the property.
-           * The integrated strains needs the gradients of the velocity.
+           * @copydoc aspect::Particle::Property::Interface::get_update_flags()
            */
           UpdateFlags
-          get_needed_update_flags () const override;
+          get_update_flags (const unsigned int component) const override;
 
           /**
            * Set up the information about the names and number of components

include/aspect/particle/property/cpo_elastic_tensor.h

@@ -104,11 +104,10 @@ namespace aspect
           need_update () const override;
 
           /**
-           * Return which data has to be provided to update the property.
-           * For example, the strains needs the gradients of the velocity.
+           * @copydoc aspect::Particle::Property::Interface::get_update_flags()
            */
           UpdateFlags
-          get_needed_update_flags () const override;
+          get_update_flags (const unsigned int component) const override;
 
           /**
            * Set up the information about the names and number of components

include/aspect/particle/property/crystal_preferred_orientation.h

@@ -178,11 +178,10 @@ namespace aspect
           late_initialization_mode () const override;
 
           /**
-           * Return which data has to be provided to update the property.
-           * The integrated strains needs the gradients of the velocity.
+           * @copydoc aspect::Particle::Property::Interface::get_update_flags()
            */
           UpdateFlags
-          get_needed_update_flags () const override;
+          get_update_flags (const unsigned int component) const override;
 
           /**
            * Set up the information about the names and number of components

include/aspect/particle/property/elastic_stress.h

@@ -71,10 +71,10 @@ namespace aspect
           need_update () const override;
 
           /**
-           * @copydoc aspect::Particle::Property::Interface::get_needed_update_flags()
+           * @copydoc aspect::Particle::Property::Interface::get_update_flags()
            */
           UpdateFlags
-          get_needed_update_flags () const override;
+          get_update_flags (const unsigned int component) const override;
 
           /**
            * @copydoc aspect::Particle::Property::Interface::get_property_information()

include/aspect/particle/property/grain_size.h

@@ -85,10 +85,10 @@ namespace aspect
           need_update () const override;
 
           /**
-           * @copydoc aspect::Particle::Property::Interface::get_needed_update_flags()
+           * @copydoc aspect::Particle::Property::Interface::get_update_flags()
            */
           UpdateFlags
-          get_needed_update_flags () const override;
+          get_update_flags (const unsigned int component) const override;
 
           /**
            * @copydoc aspect::Particle::Property::Interface::get_property_information()

include/aspect/particle/property/integrated_strain.h

@@ -73,11 +73,10 @@ namespace aspect
           need_update () const override;
 
           /**
-           * Return which data has to be provided to update the property.
-           * The integrated strains needs the gradients of the velocity.
+           * @copydoc aspect::Particle::Property::Interface::get_update_flags()
            */
           UpdateFlags
-          get_needed_update_flags () const override;
+          get_update_flags (const unsigned int component) const override;
 
           /**
            * Set up the information about the names and number of components

include/aspect/particle/property/integrated_strain_invariant.h

@@ -72,11 +72,10 @@ namespace aspect
           need_update () const override;
 
           /**
-           * Return which data has to be provided to update the property.
-           * The integrated strains needs the gradients of the velocity.
+           * @copydoc aspect::Particle::Property::Interface::get_update_flags()
            */
           UpdateFlags
-          get_needed_update_flags () const override;
+          get_update_flags (const unsigned int component) const override;
 
           /**
            * Set up the information about the names and number of components

include/aspect/particle/property/interface.h

@@ -434,14 +434,42 @@ namespace aspect
           UpdateTimeFlags
           need_update () const;
 
+          /**
+           * Return which data of the solution component @p component
+           * has to be provided to update the current particle property.
+           *
+           * Note that particle properties can only ask for update_default
+           * (no data), update_values (solution values), and update_gradients
+           * (solution gradients). All other update flags will have no effect.
+           *
+           * As an example consider a particle property that depends on the
+           * solution values and gradients of the velocity field. In this case
+           * the function should return update_values | update_gradients if the
+           * @p component is one of the velocity components, and update_default
+           * otherwise.
+           *
+           * @param component The component of the solution which is to be
+           * evaluated.
+           *
+           * @return The necessary update flags for the solution component
+           * @p component that is required for this particle property.
+           */
+          virtual
+          UpdateFlags
+          get_update_flags (const unsigned int component) const;
+
           /**
            * Return which data has to be provided to update all properties.
            * Note that particle properties can only ask for update_default
            * (no data), update_values (solution values), and update_gradients
            * (solution gradients). All other update flags will have no effect.
            *
            * @return The necessary update flags for this particle property.
+           *
+           * @deprecated This function is deprecated. Use the above version of
+           * get_update_flags() instead.
            */
+          DEAL_II_DEPRECATED
           virtual
           UpdateFlags
           get_needed_update_flags () const;
@@ -624,9 +652,16 @@ namespace aspect
            * Note that particle properties can only ask for update_default
            * (no data), update_values (solution values), and update_gradients
            * (solution gradients). All other update flags will have no effect.
+           * The result of this function is a combination of the
+           * get_update_flags() functions of all individual properties
+           * that are selected.
+           *
+           * @return A vector that contains the update flags that are
+           * required to update all particle properties. The vector has as many entries
+           * as there solution components.
            */
-          UpdateFlags
-          get_needed_update_flags () const;
+          std::vector<UpdateFlags>
+          get_update_flags () const;
 
           /**
            * Checks if the particle plugin specified by @p name exists