NucleusRefinementFunction< dim > Class Template Reference

The class handles the stochastic nucleation in PRISMS-PF. More...

#include <nucleus_refinement_function.h>

Inheritance diagram for NucleusRefinementFunction< dim >:

Collaboration diagram for NucleusRefinementFunction< dim >:

Public Types
using	CellIterator = dealii::CellAccessor< dim >
Public Types inherited from CellMarkerBase< dim >
using	CellIterator = dealii::CellAccessor< dim >

Public Member Functions
	NucleusRefinementFunction (const NucleationParameters &_nuc_params, const std::vector< Nucleus< dim > > &_nuclei_list)
bool	flag (const CellIterator &cell, const SimulationTimer &time_info) const override
Public Member Functions inherited from CellMarkerBase< dim >
virtual	~CellMarkerBase ()=default
	Destructor.
virtual bool	flag (const dealii::Point< dim > &point, const SimulationTimer &time_info) const

Public Attributes
const NucleationParameters *	nuc_params
const std::vector< Nucleus< dim > > *	nuclei_list

Detailed Description

template<unsigned int dim>
class NucleusRefinementFunction< dim >

The class handles the stochastic nucleation in PRISMS-PF.

Member Typedef Documentation

CellIterator

template<unsigned int dim>

using NucleusRefinementFunction< dim >::CellIterator = dealii::CellAccessor<dim>

Constructor & Destructor Documentation

NucleusRefinementFunction()

template<unsigned int dim>

NucleusRefinementFunction< dim >::NucleusRefinementFunction ( const NucleationParameters &  _nuc_params, const std::vector< Nucleus< dim > > &  _nuclei_list  )

inline

Member Function Documentation

flag()

template<unsigned int dim>

bool NucleusRefinementFunction< dim >::flag ( const CellIterator &  cell, const SimulationTimer &  time_info  ) const

inlineoverridevirtual

Reimplemented from CellMarkerBase< dim >.

Member Data Documentation

nuc_params

template<unsigned int dim>

const NucleationParameters* NucleusRefinementFunction< dim >::nuc_params

nuclei_list

template<unsigned int dim>

const std::vector<Nucleus<dim> >* NucleusRefinementFunction< dim >::nuclei_list

---

The documentation for this class was generated from the following file:

• /home/runner/work/phaseField/phaseField/include/prismspf/nucleation/nucleus_refinement_function.h