#include <AllenCahn.H>

Inheritance diagram for Integrator::AllenCahn:

Public Member Functions
	AllenCahn ()

	AllenCahn (IO::ParmParse &pp)

	~AllenCahn ()

Public Member Functions inherited from Integrator::Integrator
	Integrator ()

virtual	~Integrator ()

void	InitData ()

void	Restart (std::string restartfile, bool a_node=false)

void	Evolve ()

void	SetFilename (std::string _plot_file)

std::string	GetFilename ()

void	regrid (int lbase, Set::Scalar time, bool initial=false) override

void	InitFromScratch (Set::Scalar time)

template<class T , int d>
ALAMO_SINGLE_DEFINITION void	AddField (Set::Field< T > &new_field, BC::BC< T > *new_bc, int ncomp, int nghost, std::string name, bool writeout, bool evolving, std::vector< std::string >)

template<class T >
ALAMO_SINGLE_DEFINITION void	RegisterGeneralFab (Set::Field< T > &new_fab, int ncomp, int nghost, bool evolving)

template<class T >
ALAMO_SINGLE_DEFINITION void	RegisterGeneralFab (Set::Field< T > &new_fab, int ncomp, int nghost, std::string a_name, bool evolving)

template<class T >
AMREX_ATTRIBUTE_WEAK void	RegisterGeneralFab (Set::Field< T > &new_fab, int ncomp, int nghost, bool writeout, std::string a_name, bool evolving)

Static Public Member Functions
static void	Parse (AllenCahn &value, IO::ParmParse &pp)

Static Public Attributes
static constexpr const char *	name = "allencahn"

Protected Member Functions
void	Initialize (int lev)

void	Advance (int lev, Set::Scalar time, Set::Scalar dt)

void	TagCellsForRefinement (int lev, amrex::TagBoxArray &a_tags, Set::Scalar, int)

Protected Member Functions inherited from Integrator::Integrator
virtual void	TimeStepBegin (Set::Scalar, int)

virtual void	TimeStepComplete (Set::Scalar, int)

virtual void	Integrate (int, Set::Scalar, int, const amrex::MFIter &, const amrex::Box &)

virtual void	Regrid (int, Set::Scalar)

void	RegisterNewFab (Set::Field< Set::Scalar > &new_fab, BC::BC< Set::Scalar > *new_bc, int ncomp, int nghost, std::string name, bool writeout, bool evolving=true, std::vector< std::string > suffix={})

void	RegisterNewFab (Set::Field< Set::Scalar > &new_fab, int ncomp, std::string name, bool writeout, bool evolving=true, std::vector< std::string > suffix={})

void	RegisterNodalFab (Set::Field< Set::Scalar > &new_fab, int ncomp, int nghost, std::string name, bool writeout, bool evolving=true, std::vector< std::string > suffix={})

void	RegisterNodalFab (Set::Field< Set::Scalar > &new_fab, BC::BC< Set::Scalar > *new_bc, int ncomp, int nghost, std::string name, bool writeout, bool evolving=true, std::vector< std::string > suffix={})

template<class T >
void	RegisterGeneralFab (Set::Field< T > &new_fab, int ncomp, int nghost, bool evolving=true)

template<class T >
void	RegisterGeneralFab (Set::Field< T > &new_fab, int ncomp, int nghost, std::string a_name, bool evolving=true)

template<class T >
void	RegisterGeneralFab (Set::Field< T > &new_fab, int ncomp, int nghost, bool writeout, std::string a_name, bool evolving=true)

template<class T , int d>
void	AddField (Set::Field< T > &new_field, BC::BC< T > *new_bc, int ncomp, int nghost, std::string, bool writeout, bool evolving, std::vector< std::string > suffix={})

void	SetFinestLevel (const int a_finestlevel)

void	RegisterIntegratedVariable (Set::Scalar *integrated_variable, std::string name, bool extensive=true)

void	SetTimestep (Set::Scalar _timestep)

void	SetPlotInt (int plot_int)

void	SetThermoInt (int a_thermo_int)

void	SetThermoPlotInt (int a_thermo_plot_int)

void	SetStopTime (Set::Scalar a_stop_time)

void	DynamicTimestep_SyncTimeStep (int lev, Set::Scalar dt_min)

void	DynamicTimestep_Reset ()

void	DynamicTimestep_Update ()

void	IntegrateVariables (Set::Scalar cur_time, int step)

void	WritePlotFile (bool initial=false) const

void	WritePlotFile (std::string prefix, Set::Scalar time, int step) const

void	WritePlotFile (Set::Scalar time, amrex::Vector< int > iter, bool initial=false, std::string prefix="") const

Protected Attributes
Set::Field< Set::Scalar >	alpha_mf

Set::Field< Set::Scalar >	alpha_old_mf

IC::IC< Set::Scalar > *	ic

Set::Field< Set::Scalar > &	eta_mf = alpha_mf

Set::Field< Set::Scalar > &	eta_old_mf = alpha_old_mf

struct {

Set::Scalar L = NAN

Set::Scalar eps = NAN

Set::Scalar kappa = NAN

Set::Scalar lambda = NAN

Set::Scalar direction_tstart = NAN

int direction = 0

}	ch

Protected Attributes inherited from Integrator::Integrator
struct {

bool on = false

int verbose = -1

int nprevious = -1

Set::Scalar cfl = NAN

Set::Scalar min = NAN

Set::Scalar max = NAN

std::vector< Set::Scalar > dt_limit_min

std::vector< Set::Scalar > previous_timesteps

}	dynamictimestep

amrex::Vector< amrex::Real >	t_new

amrex::Vector< int >	istep

std::string	plot_file { "plt" }

amrex::Real	timestep = NAN

amrex::Vector< amrex::Real >	dt

amrex::Vector< int >	nsubsteps

bool	integrate_variables_before_advance = true

bool	integrate_variables_after_advance = false

struct {

int number_of_fabs = 0

std::vector< Set::Field< Set::Scalar > * > fab_array

std::vector< int > ncomp_array

std::vector< int > nghost_array

std::vector< std::vector< std::string > > name_array

std::vector< BC::BC< Set::Scalar > * > physbc_array

std::vector< bool > writeout_array

std::vector< bool > evolving_array

bool any = true

bool all = false

}	node

struct {

int number_of_fabs = 0

std::vector< Set::Field< Set::Scalar > * > fab_array

std::vector< int > ncomp_array

std::vector< int > nghost_array

std::vector< std::vector< std::string > > name_array

std::vector< BC::BC< Set::Scalar > * > physbc_array

std::vector< bool > writeout_array

std::vector< bool > evolving_array

bool any = true

bool all = false

}	cell

std::vector< BaseField * >	m_basefields

std::vector< BaseField * >	m_basefields_cell

BC::Nothing	bcnothing

struct {

int interval = -1

Set::Scalar dt = NAN

int plot_int = -1

Set::Scalar plot_dt = NAN

int number = 0

std::vector< Set::Scalar * > vars

std::vector< std::string > names

std::vector< bool > extensives

}	thermo

int	regrid_int = -1

int	base_regrid_int = -1

std::string	restart_file_cell = ""

std::string	restart_file_node = ""

struct {

int on = 0

std::vector< amrex::Box > box

}	explicitmesh

int	abort_on_nan = true

Private Attributes
int	number_of_components = 1

int	number_of_ghost_cells = 2

Set::Scalar	refinement_threshold = NAN

BC::BC< Set::Scalar > *	bc

Detailed Description

Definition at line 45 of file AllenCahn.H.

Constructor & Destructor Documentation

◆ AllenCahn() [1/2]

Integrator::AllenCahn::AllenCahn ( )

inline

Definition at line 51 of file AllenCahn.H.

◆ AllenCahn() [2/2]

Integrator::AllenCahn::AllenCahn ( IO::ParmParse & pp )

inline

Definition at line 55 of file AllenCahn.H.

◆ ~AllenCahn()

Integrator::AllenCahn::~AllenCahn ( )

inline

Definition at line 60 of file AllenCahn.H.

Member Function Documentation

◆ Advance()

void Integrator::AllenCahn::Advance	(	int	lev,
		Set::Scalar	time,
		Set::Scalar	dt
	)

inlineprotectedvirtual

Implements Integrator::Integrator.

Definition at line 133 of file AllenCahn.H.

◆ Initialize()

void Integrator::AllenCahn::Initialize ( int lev )

inlineprotectedvirtual

Implements Integrator::Integrator.

Definition at line 126 of file AllenCahn.H.

◆ Parse()

static void Integrator::AllenCahn::Parse	(	AllenCahn &	value,
		IO::ParmParse &	pp
	)

inlinestatic

Definition at line 72 of file AllenCahn.H.

◆ TagCellsForRefinement()

void Integrator::AllenCahn::TagCellsForRefinement	(	int	lev,
		amrex::TagBoxArray &	a_tags,
		Set::Scalar	,
		int
	)

inlineprotectedvirtual

Implements Integrator::Integrator.

Definition at line 174 of file AllenCahn.H.

Field Documentation

◆ alpha_mf

Set::Field<Set::Scalar> Integrator::AllenCahn::alpha_mf

protected

Definition at line 204 of file AllenCahn.H.

◆ alpha_old_mf

Set::Field<Set::Scalar> Integrator::AllenCahn::alpha_old_mf

protected

Temperature field variable (current timestep)

Definition at line 205 of file AllenCahn.H.

◆ bc

BC::BC<Set::Scalar>* Integrator::AllenCahn::bc

private

Definition at line 226 of file AllenCahn.H.

◆ [struct]

struct { ... } Integrator::AllenCahn::ch

◆ direction

int Integrator::AllenCahn::direction = 0

Definition at line 217 of file AllenCahn.H.

◆ direction_tstart

Set::Scalar Integrator::AllenCahn::direction_tstart = NAN

Definition at line 216 of file AllenCahn.H.

◆ eps

Set::Scalar Integrator::AllenCahn::eps = NAN

Definition at line 213 of file AllenCahn.H.

◆ eta_mf

Set::Field<Set::Scalar>& Integrator::AllenCahn::eta_mf = alpha_mf

protected

Object used to initialize temperature field.

Definition at line 208 of file AllenCahn.H.

◆ eta_old_mf

Set::Field<Set::Scalar>& Integrator::AllenCahn::eta_old_mf = alpha_old_mf

protected

Definition at line 209 of file AllenCahn.H.

◆ ic

IC::IC<Set::Scalar>* Integrator::AllenCahn::ic

protected

Temperature field variable (previous timestep)

Definition at line 206 of file AllenCahn.H.

◆ kappa

Set::Scalar Integrator::AllenCahn::kappa = NAN

Definition at line 214 of file AllenCahn.H.

◆ L

Set::Scalar Integrator::AllenCahn::L = NAN

Definition at line 212 of file AllenCahn.H.

◆ lambda

Set::Scalar Integrator::AllenCahn::lambda = NAN

Definition at line 215 of file AllenCahn.H.

◆ name

constexpr const char* Integrator::AllenCahn::name = "allencahn"

staticconstexpr

Definition at line 48 of file AllenCahn.H.

◆ number_of_components

int Integrator::AllenCahn::number_of_components = 1

private

Definition at line 221 of file AllenCahn.H.

◆ number_of_ghost_cells

int Integrator::AllenCahn::number_of_ghost_cells = 2

private

Definition at line 222 of file AllenCahn.H.

◆ refinement_threshold

Set::Scalar Integrator::AllenCahn::refinement_threshold = NAN

private

Definition at line 224 of file AllenCahn.H.

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

src/Integrator/AllenCahn.H

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AllenCahn() [1/2]

◆ AllenCahn() [2/2]

◆ ~AllenCahn()

Member Function Documentation

◆ Advance()

◆ Initialize()

◆ Parse()

◆ TagCellsForRefinement()

Field Documentation

◆ alpha_mf

◆ alpha_old_mf

◆ bc

◆ [struct]

◆ direction

◆ direction_tstart

◆ eps

◆ eta_mf

◆ eta_old_mf

◆ ic

◆ kappa

◆ L

◆ lambda

◆ name

◆ number_of_components

◆ number_of_ghost_cells

◆ refinement_threshold