handler.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2011-2025 by the ASPECT authors.
//
// This file is part of ASPECT.
//
// Detailed license information governing the source code and
// contributions can be found in the folder LICENSES and in
// LICENSE and CONTRIBUTING.md at the top level directory.
//
// ------------------------------------------------------

#ifndef _aspect_volume_of_fluid_handler_h
#define _aspect_volume_of_fluid_handler_h

#include <aspect/simulator.h>
#include <aspect/simulator_access.h>
#include <aspect/volume_of_fluid/field.h>
#include <aspect/volume_of_fluid/assembly.h>

#include <boost/serialization/map.hpp>

namespace aspect
{
  template <int dim>
  class VolumeOfFluidHandler : public SimulatorAccess<dim>
  {
    public:
      VolumeOfFluidHandler(Simulator<dim> &simulator, ParameterHandler &prm);

      void edit_finite_element_variables (std::vector<VariableDeclaration<dim>> &vars);

      static
      void declare_parameters (ParameterHandler &prm);

      void parse_parameters (ParameterHandler &prm);

      unsigned int get_n_fields() const;

      const std::string name_for_field_index(unsigned int i) const;

      const VolumeOfFluidField<dim> &field_struct_for_field_index(unsigned int i) const;

      double get_volume_fraction_threshold() const;

      unsigned int field_index_for_name(const std::string &fieldname) const;

      void initialize (ParameterHandler &prm);

      void set_initial_volume_fractions ();

      void initialize_from_composition_field (const VolumeOfFluidField<dim> &field);

      void initialize_from_level_set (const VolumeOfFluidField<dim> &field);

      void update_volume_of_fluid_normals (const VolumeOfFluidField<dim> &field,
                                           LinearAlgebra::BlockVector &solution);

      void update_volume_of_fluid_composition (const AdvectionField &composition_field,
                                               const VolumeOfFluidField<dim> &volume_of_fluid_field,
                                               LinearAlgebra::BlockVector &solution);

      void do_volume_of_fluid_update (const AdvectionField &advection_field);

      void assemble_volume_of_fluid_system (const VolumeOfFluidField<dim> &field,
                                            const unsigned int calculation_dim,
                                            const bool update_from_old_solution);

      void solve_volume_of_fluid_system (const VolumeOfFluidField<dim> &field);


    private:
      Simulator<dim> &sim;

      void copy_local_to_global_volume_of_fluid_system (const internal::Assembly::CopyData::VolumeOfFluidSystem<dim> &data);

      Assemblers::VolumeOfFluidAssembler<dim> assembler;

      unsigned int n_volume_of_fluid_fields;

      std::vector<VolumeOfFluidField<dim>> data;

      double volume_fraction_threshold;

      static constexpr double volume_of_fluid_reconstruct_epsilon = 1e-13;

      double volume_of_fluid_solver_tolerance;

      unsigned int n_init_samples;

      std::vector<std::string> volume_of_fluid_field_names;

      std::map<unsigned int, unsigned int> volume_of_fluid_composition_map_index;

      std::vector<VolumeOfFluid::VolumeOfFluidInputType::Kind> initialization_data_type;

      friend class Simulator<dim>;
  };


  // Declare the existence of explicit specializations
  template <>
  void VolumeOfFluidHandler<2>::update_volume_of_fluid_normals (const VolumeOfFluidField<2> &field,
                                                                LinearAlgebra::BlockVector &solution);
  template <>
  void VolumeOfFluidHandler<3>::update_volume_of_fluid_normals (const VolumeOfFluidField<3> &/*field*/,
                                                                LinearAlgebra::BlockVector &/*solution*/);
  template <>
  void VolumeOfFluidHandler<2>::update_volume_of_fluid_composition (const typename Simulator<2>::AdvectionField &composition_field,
                                                                    const VolumeOfFluidField<2> &volume_of_fluid_field,
                                                                    LinearAlgebra::BlockVector &solution);
  template <>
  void VolumeOfFluidHandler<3>::update_volume_of_fluid_composition (const Simulator<3>::AdvectionField &/*composition_field*/,
                                                                    const VolumeOfFluidField<3> &/*volume_of_fluid_field*/,
                                                                    LinearAlgebra::BlockVector &/*solution*/);

}

#endif