Inheritance diagram for CahnHilliard:

Collaboration diagram for CahnHilliard:

Public Member Functions
	CahnHilliard (FFT &fft, const World &world)
	Constructs a CahnHilliard instance with the given World object.

void	initialize (double dt) override

void	step (double) override

Public Member Functions inherited from pfc::Model
	~Model ()
	Destroy the Model object.

	Model (FFT &fft, const World &world)

	Model (const Model &)=delete
	Disable copy constructor.

Model &	operator= (const Model &)=delete
	Disable copy assignment operator.

bool	is_rank0 () const noexcept
	Check if current MPI rank is 0.

const World &	get_world () const noexcept
	Get the decomposition object associated with the model.

FFT &	get_fft () noexcept

virtual size_t	get_allocated_memory_bytes () const

bool	has_real_field (std::string_view field_name) const noexcept
	Check if the model has a real-valued field with the given name.

void	add_real_field (std::string_view name, RealField &field)

bool	has_complex_field (std::string_view field_name) const noexcept

void	add_complex_field (std::string_view name, ComplexField &field)

RealField &	get_real_field (std::string_view name)

const RealField &	get_real_field (std::string_view name) const
	Retrieve a registered real-valued field by name (const version)

ComplexField &	get_complex_field (std::string_view name)

const ComplexField &	get_complex_field (std::string_view name) const
	Retrieve a registered complex-valued field by name (const version)

void	add_field (const std::string &name, RealField &field)
	Add a field to the model.

void	add_field (const std::string &name, ComplexField &field)
	Add a field to the model.

bool	has_field (std::string_view field_name) const noexcept

virtual Field &	get_field ()
	Get a reference to the default primary unknown field.

Constructor & Destructor Documentation

◆ CahnHilliard()

CahnHilliard::CahnHilliard	(	FFT &	fft,
		const World &	world
	)

inlineexplicit

Constructs a CahnHilliard instance with the given World object.

Parameters

world The World object to initialize the model.

Member Function Documentation

◆ initialize()

void CahnHilliard::initialize ( double dt )

inlineoverridevirtual

Implements pfc::Model.

◆ step()

void CahnHilliard::step ( double )