nucleation_parameters.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2026 PRISMS Center at the University of Michigan
// SPDX-License-Identifier: GNU Lesser General Public Version 2.1
 
#pragma once
 
#include <deal.II/base/parameter_handler.h>
 
#include <prismspf/core/conditional_ostreams.h>
#include <prismspf/core/exceptions.h>
#include <prismspf/core/simulation_timer.h>
 
#include <prismspf/nucleation/nucleus.h>
 
#include <prismspf/user_inputs/parameter_base.h>
#include <prismspf/user_inputs/temporal_discretization.h>
 
#include <prismspf/utilities/utilities.h>
 
#include <prismspf/config.h>
 
#include <climits>
#include <string>
 
PRISMS_PF_BEGIN_NAMESPACE

struct NucleationParameters : public ParameterBase
{
  static void
  declare(dealii::ParameterHandler &parameter_handler,
          unsigned int              n_subsections = Numbers::default_subsections);

  void
  assign(dealii::ParameterHandler &parameter_handler,
         unsigned int              n_subsections = Numbers::default_subsections) override;

  void
  validate(const std::vector<FieldAttributes> &field_attributes,
           const std::vector<SolveBlock>      &solve_blocks) const override;

  [[nodiscard]] bool
  should_attempt_nucleation(unsigned int increment) const;

  template <unsigned int dim>
  [[nodiscard]] bool
  check_active(const Nucleus<dim> &nucleus, const SimulationTimer &time_info) const;
 
  // The number of steps between nucleationting relevant information to screen
  unsigned int nucleation_period = UINT_MAX;
 
  // Whether a postprocess field is being used for nucleation
  bool pp_nucleation_rate_exists = false;
 
  // The radius around a nucleus to exclude other nuclei
  double nucleus_exclusion_distance = 0.0;
 
  // The radius around a nucleus to exclude other nuclei in the same field
  double same_field_nucleus_exclusion_distance = 0.0;
 
  // The radius around a nucleus to refine the mesh
  double refinement_radius = 0.0;
 
  // Seeding time
  double seeding_time = 0.0;
 
  // Seeding increments
  unsigned int seeding_increments = 1;
};
 
PRISMS_PF_END_NAMESPACE