Alamo
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
Integrator::Integrator Class Referenceabstract
Inheritance diagram for Integrator::Integrator:
[legend]
Collaboration diagram for Integrator::Integrator:
[legend]

Public Member Functions

 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)
 

Protected Member Functions

virtual void Initialize (int lev)=0
 
virtual void Advance (int lev, amrex::Real time, amrex::Real dt)=0
 
virtual void TagCellsForRefinement (int lev, amrex::TagBoxArray &tags, amrex::Real time, int ngrow)=0
 
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, std::vector< std::string > suffix={})
 
void RegisterNewFab (Set::Field< Set::Scalar > &new_fab, int ncomp, std::string name, bool writeout, std::vector< std::string > suffix={})
 
void RegisterNodalFab (Set::Field< Set::Scalar > &new_fab, int ncomp, int nghost, std::string name, bool writeout, 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, 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

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
 
   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
 
   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 Member Functions

virtual void MakeNewLevelFromScratch (int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
 
virtual void MakeNewLevelFromCoarse (int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
 
virtual void RemakeLevel (int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
 
virtual void ClearLevel (int lev) override
 
virtual void ErrorEst (int lev, amrex::TagBoxArray &tags, amrex::Real time, int ngrow) override
 
void FillPatch (int lev, amrex::Real time, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &source_mf, amrex::MultiFab &destination_multifab, BC::BC< Set::Scalar > &physbc, int icomp)
 
long CountCells (int lev)
 
void TimeStep (int lev, amrex::Real time, int iteration)
 
void FillCoarsePatch (int lev, amrex::Real time, Set::Field< Set::Scalar > &mf, BC::BC< Set::Scalar > &physbc, int icomp, int ncomp)
 
void GetData (const int lev, const amrex::Real time, amrex::Vector< amrex::MultiFab * > &data, amrex::Vector< amrex::Real > &datatime)
 
std::vector< std::string > PlotFileName (int lev, std::string prefix="") const
 

Private Attributes

int max_plot_level = -1
 
amrex::Vector< amrex::Real > t_old
 
int max_step = std::numeric_limits<int>::max()
 
amrex::Real tstart = 0
 
amrex::Real stop_time = NAN
 

Detailed Description

Definition at line 73 of file Integrator.H.

Constructor & Destructor Documentation

◆ Integrator()

Integrator::Integrator::Integrator ( )

Constructor.

\function Integrator Does the following things:

  • Read in simulation TIME(STEP) information
  • Read in simulation output and AMR information
  • Initalize timestep substep information
  • Create a clean directory For derived classes this must be called for the derived constructor. For instance: code
    class MyDerivedClass : Integrator
    {
    MyDerivedClass() : Integrator() { ... }
    ...
    }

Definition at line 17 of file Integrator.cpp.

Here is the call graph for this function:

◆ ~Integrator()

Integrator::Integrator::~Integrator ( )
virtual

Does nothing – check here first if there are memory leaks.

\func ~Integrator

Definition at line 165 of file Integrator.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ AddField() [1/2]

template<class T , int d>
ALAMO_SINGLE_DEFINITION void Integrator::Integrator::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 >   
)

Definition at line 556 of file Integrator.H.

Here is the call graph for this function:

◆ AddField() [2/2]

template<class T , int d>
void Integrator::Integrator::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 = {} 
)
protected

◆ Advance()

Integrator::Integrator::Advance ( int  lev,
amrex::Real  time,
amrex::Real  dt 
)
protectedpure virtual

Perform computation.

You must override this function to inherit this class. Advance is called every time(sub)step, and implements the evolution of the system in time.

Parameters
[in]lev[in] AMR Level
[in]time[in] System time
[in]dt[in] Timestep for this level

Implemented in Integrator::Fracture, Integrator::SutureCrack, Integrator::HeatConduction, Integrator::AllenCahn, Integrator::Dendrite, Integrator::Base::Mechanics< MODEL >, Integrator::Base::Mechanics< Model::Solid::Affine::Isotropic >, Integrator::Base::Mechanics< model_type >, Integrator::Base::Mechanics< Model::Solid::Finite::NeoHookeanPredeformed >, Integrator::TopOp< MODEL >, Integrator::Flame, Integrator::CahnHilliard, and Integrator::ThermoElastic.

◆ ClearLevel()

void Integrator::Integrator::ClearLevel ( int  lev)
overrideprivatevirtual

Definition at line 292 of file Integrator.cpp.

◆ CountCells()

long Integrator::Integrator::CountCells ( int  lev)
private

Definition at line 352 of file Integrator.cpp.

◆ DynamicTimestep_Reset()

void Integrator::Integrator::DynamicTimestep_Reset ( )
inlineprotected

Definition at line 291 of file Integrator.H.

◆ DynamicTimestep_SyncTimeStep()

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

Definition at line 278 of file Integrator.H.

◆ DynamicTimestep_Update()

void Integrator::Integrator::DynamicTimestep_Update ( )
inlineprotected

Definition at line 296 of file Integrator.H.

Here is the call graph for this function:

◆ ErrorEst()

void Integrator::Integrator::ErrorEst ( int  lev,
amrex::TagBoxArray &  tags,
amrex::Real  time,
int  ngrow 
)
overrideprivatevirtual

Definition at line 458 of file Integrator.cpp.

◆ Evolve()

Integrator::Integrator::Evolve ( )

Front-end method to start simulation.

Definition at line 987 of file Integrator.cpp.

Here is the call graph for this function:

◆ FillCoarsePatch()

void Integrator::Integrator::FillCoarsePatch ( int  lev,
amrex::Real  time,
Set::Field< Set::Scalar > &  mf,
BC::BC< Set::Scalar > &  physbc,
int  icomp,
int  ncomp 
)
private

Fill a fab at current level with the data from one level up.

Note
This is a custom method and is changeable
Parameters
[in]lev[in] AMR level
[in]time[in] Simulatinon time
[in]mf[in] Fab to fill
[in]physbc[in] BC object applying to Fab
[in]icomp[in] start component
[in]ncomp[in] end component (i.e. applies to components `icomp`...`ncomp`)

Definition at line 427 of file Integrator.cpp.

Here is the call graph for this function:

◆ FillPatch()

void Integrator::Integrator::FillPatch ( int  lev,
amrex::Real  time,
amrex::Vector< std::unique_ptr< amrex::MultiFab >> &  source_mf,
amrex::MultiFab &  destination_multifab,
BC::BC< Set::Scalar > &  physbc,
int  icomp 
)
private

Definition at line 368 of file Integrator.cpp.

Here is the call graph for this function:

◆ GetData()

void Integrator::Integrator::GetData ( const int  lev,
const amrex::Real  time,
amrex::Vector< amrex::MultiFab * > &  data,
amrex::Vector< amrex::Real > &  datatime 
)
private

◆ GetFilename()

std::string Integrator::Integrator::GetFilename ( )
inline

Definition at line 109 of file Integrator.H.

◆ InitData()

void Integrator::Integrator::InitData ( )

Definition at line 466 of file Integrator.cpp.

◆ InitFromScratch()

void Integrator::Integrator::InitFromScratch ( Set::Scalar  time)
inline

Definition at line 117 of file Integrator.H.

◆ Initialize()

Integrator::Integrator::Initialize ( int  lev)
protectedpure virtual

Apply initial conditions.

You must override this function to inherit this class. This function is called before the simulation begins, and is where initial conditions should be applied.

Parameters
[in]lev[in] AMR Level

Implemented in Integrator::PhaseFieldMicrostructure< model_type >, Integrator::Mechanics< MODEL >, Integrator::Mechanics< Model::Solid::Affine::Isotropic >, Integrator::Base::Mechanics< MODEL >, Integrator::Base::Mechanics< Model::Solid::Affine::Isotropic >, Integrator::Base::Mechanics< model_type >, Integrator::Base::Mechanics< Model::Solid::Finite::NeoHookeanPredeformed >, Integrator::TopOp< MODEL >, Integrator::Flame, Integrator::CahnHilliard, Integrator::ThermoElastic, Integrator::HeatConduction, Integrator::AllenCahn, Integrator::Dendrite, Integrator::Fracture, and Integrator::SutureCrack.

◆ Integrate()

Integrator::Integrator::Integrate ( int  ,
Set::Scalar  ,
int  ,
const amrex::MFIter &  ,
const amrex::Box &   
)
inlineprotectedvirtual

Perform an integration to compute integrated quantities.

This is a function that is called by Integrator to update the variables registered in RegisterIntegratedVariable. The following variables are used:

  • amrlev: current amr level
  • time: current simulation time
  • iter: current simulation iteration
  • mfi: current MFIter object (used to get FArrayBox from MultiFab)
  • box: Use this box (not mfi.tilebox). This box covers only cells on this level that are not also on a finer level.

Reimplemented in Integrator::Fracture, Integrator::SutureCrack, Integrator::Base::Mechanics< MODEL >, Integrator::Base::Mechanics< Model::Solid::Affine::Isotropic >, Integrator::Base::Mechanics< model_type >, Integrator::Base::Mechanics< Model::Solid::Finite::NeoHookeanPredeformed >, Integrator::PhaseFieldMicrostructure< model_type >, Integrator::TopOp< MODEL >, and Integrator::Flame.

Definition at line 213 of file Integrator.H.

Here is the call graph for this function:

◆ IntegrateVariables()

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

Definition at line 1038 of file Integrator.cpp.

◆ MakeNewLevelFromCoarse()

void Integrator::Integrator::MakeNewLevelFromCoarse ( int  lev,
amrex::Real  time,
const amrex::BoxArray &  ba,
const amrex::DistributionMapping &  dm 
)
overrideprivatevirtual

Wrapper to call FillCoarsePatch.

Note
THIS OVERRIDES A PURE VIRTUAL METHOD - DO NOT CHANGE

Definition at line 193 of file Integrator.cpp.

◆ MakeNewLevelFromScratch()

void Integrator::Integrator::MakeNewLevelFromScratch ( int  lev,
amrex::Real  time,
const amrex::BoxArray &  ba,
const amrex::DistributionMapping &  dm 
)
overrideprivatevirtual

Definition at line 674 of file Integrator.cpp.

Here is the call graph for this function:

◆ PlotFileName()

std::vector< std::string > Integrator::Integrator::PlotFileName ( int  lev,
std::string  prefix = "" 
) const
private

Definition at line 733 of file Integrator.cpp.

◆ RegisterGeneralFab() [1/6]

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

Definition at line 595 of file Integrator.H.

◆ RegisterGeneralFab() [2/6]

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

◆ RegisterGeneralFab() [3/6]

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

Definition at line 609 of file Integrator.H.

◆ RegisterGeneralFab() [4/6]

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

◆ RegisterGeneralFab() [5/6]

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

Definition at line 602 of file Integrator.H.

◆ RegisterGeneralFab() [6/6]

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

◆ RegisterIntegratedVariable()

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

Definition at line 342 of file Integrator.cpp.

◆ RegisterNewFab() [1/2]

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

Definition at line 314 of file Integrator.cpp.

◆ RegisterNewFab() [2/2]

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

Definition at line 320 of file Integrator.cpp.

◆ RegisterNodalFab() [1/2]

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

Definition at line 326 of file Integrator.cpp.

◆ RegisterNodalFab() [2/2]

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

Definition at line 332 of file Integrator.cpp.

◆ regrid()

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

Definition at line 111 of file Integrator.H.

◆ Regrid()

virtual void Integrator::Integrator::Regrid ( int  ,
Set::Scalar   
)
inlineprotectedvirtual

Reimplemented in Integrator::Mechanics< MODEL >, Integrator::Mechanics< Model::Solid::Affine::Isotropic >, and Integrator::Flame.

Definition at line 220 of file Integrator.H.

◆ RemakeLevel()

void Integrator::Integrator::RemakeLevel ( int  lev,
amrex::Real  time,
const amrex::BoxArray &  cgrids,
const amrex::DistributionMapping &  dm 
)
overrideprivatevirtual

RESETS ALL MULTIFABS AT A GIVEN LEVEL

(OVERRIDES PURE VIRTUAL METHOD - DO NOT CHANGE)

Parameters
[in]lev[in] AMR Level
[in]time[in] Simulation time

Definition at line 242 of file Integrator.cpp.

◆ Restart()

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

Definition at line 500 of file Integrator.cpp.

Here is the call graph for this function:

◆ SetFilename()

void Integrator::Integrator::SetFilename ( std::string  _plot_file)
inline

Definition at line 108 of file Integrator.H.

◆ SetFinestLevel()

void Integrator::Integrator::SetFinestLevel ( const int  a_finestlevel)
inlineprotected

Definition at line 243 of file Integrator.H.

◆ SetPlotInt()

void Integrator::Integrator::SetPlotInt ( int  plot_int)
protected

Definition at line 182 of file Integrator.cpp.

◆ SetStopTime()

void Integrator::Integrator::SetStopTime ( Set::Scalar  a_stop_time)
inlineprotected

Definition at line 261 of file Integrator.H.

◆ SetThermoInt()

void Integrator::Integrator::SetThermoInt ( int  a_thermo_int)
inlineprotected

Definition at line 259 of file Integrator.H.

◆ SetThermoPlotInt()

void Integrator::Integrator::SetThermoPlotInt ( int  a_thermo_plot_int)
inlineprotected

Definition at line 260 of file Integrator.H.

◆ SetTimestep()

void Integrator::Integrator::SetTimestep ( Set::Scalar  _timestep)
protected

Definition at line 172 of file Integrator.cpp.

◆ TagCellsForRefinement()

Integrator::Integrator::TagCellsForRefinement ( int  lev,
amrex::TagBoxArray &  tags,
amrex::Real  time,
int  ngrow 
)
protectedpure virtual

Tag cells where mesh refinement is needed.

You must override this function to inherit this class. Advance is called every time(sub)step, and implements the evolution of the system in time.

Implemented in Integrator::Flame, Integrator::PhaseFieldMicrostructure< model_type >, Integrator::CahnHilliard, Integrator::Base::Mechanics< MODEL >, Integrator::Base::Mechanics< Model::Solid::Affine::Isotropic >, Integrator::Base::Mechanics< model_type >, Integrator::Base::Mechanics< Model::Solid::Finite::NeoHookeanPredeformed >, Integrator::Dendrite, Integrator::AllenCahn, Integrator::HeatConduction, Integrator::Mechanics< MODEL >, Integrator::Mechanics< Model::Solid::Affine::Isotropic >, Integrator::TopOp< MODEL >, Integrator::Fracture, Integrator::SutureCrack, and Integrator::ThermoElastic.

◆ TimeStep()

void Integrator::Integrator::TimeStep ( int  lev,
amrex::Real  time,
int  iteration 
)
private

Definition at line 1118 of file Integrator.cpp.

◆ TimeStepBegin()

Integrator::Integrator::TimeStepBegin ( Set::Scalar  ,
int   
)
inlineprotectedvirtual

Run another system calculation (e.g. implicit solve) before integration step.

This function is called at the beginning of every timestep. This function can be used to complete additional global solves, e.g. a MLMG implicit solve.

Overriding is optional; the default is to do nothing.

Reimplemented in Integrator::Fracture, Integrator::SutureCrack, Integrator::Base::Mechanics< MODEL >, Integrator::Base::Mechanics< Model::Solid::Affine::Isotropic >, Integrator::Base::Mechanics< model_type >, Integrator::Base::Mechanics< Model::Solid::Finite::NeoHookeanPredeformed >, Integrator::ThermoElastic, Integrator::Flame, Integrator::CahnHilliard, and Integrator::PhaseFieldMicrostructure< model_type >.

Definition at line 189 of file Integrator.H.

◆ TimeStepComplete()

Integrator::Integrator::TimeStepComplete ( Set::Scalar  ,
int   
)
inlineprotectedvirtual

Run another system calculation (e.g. implicit solve) after integration step.

This function is called at the end of every timestep. This function can be used to complete additional global solves, e.g. a MLMG implicit solve.

Overriding is optional; the default is to do nothing.

Reimplemented in Integrator::Flame, Integrator::Fracture, Integrator::SutureCrack, and Integrator::PhaseFieldMicrostructure< model_type >.

Definition at line 199 of file Integrator.H.

◆ WritePlotFile() [1/3]

void Integrator::Integrator::WritePlotFile ( bool  initial = false) const
protected

Definition at line 743 of file Integrator.cpp.

◆ WritePlotFile() [2/3]

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

Definition at line 755 of file Integrator.cpp.

Here is the call graph for this function:

◆ WritePlotFile() [3/3]

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

Definition at line 748 of file Integrator.cpp.

Field Documentation

◆ abort_on_nan

int Integrator::Integrator::abort_on_nan = true
protected

Definition at line 470 of file Integrator.H.

◆ all

bool Integrator::Integrator::all = false

Definition at line 422 of file Integrator.H.

◆ any

bool Integrator::Integrator::any = true

Definition at line 421 of file Integrator.H.

◆ base_regrid_int

int Integrator::Integrator::base_regrid_int = -1
protected

Determine how often to regrid based on coarse level only (default: 0)

Definition at line 456 of file Integrator.H.

◆ bcnothing

BC::Nothing Integrator::Integrator::bcnothing
protected

Definition at line 440 of file Integrator.H.

◆ box

std::vector<amrex::Box> Integrator::Integrator::box

Definition at line 463 of file Integrator.H.

◆ cell

struct { ... } Integrator::Integrator::cell

◆ cfl

Set::Scalar Integrator::Integrator::cfl = NAN

Definition at line 271 of file Integrator.H.

◆ dt [1/2]

amrex::Vector<amrex::Real> Integrator::Integrator::dt
protected

Timesteps for each level of refinement.

Definition at line 398 of file Integrator.H.

◆ dt [2/2]

Set::Scalar Integrator::Integrator::dt = NAN

Definition at line 445 of file Integrator.H.

◆ dt_limit_min

std::vector<Set::Scalar> Integrator::Integrator::dt_limit_min

Definition at line 275 of file Integrator.H.

◆ dynamictimestep

struct { ... } Integrator::Integrator::dynamictimestep

◆ explicitmesh

struct { ... } Integrator::Integrator::explicitmesh

◆ extensives

std::vector<bool> Integrator::Integrator::extensives

Definition at line 451 of file Integrator.H.

◆ fab_array

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

Definition at line 415 of file Integrator.H.

◆ integrate_variables_after_advance

bool Integrator::Integrator::integrate_variables_after_advance = false
protected

Definition at line 410 of file Integrator.H.

◆ integrate_variables_before_advance

bool Integrator::Integrator::integrate_variables_before_advance = true
protected

Definition at line 409 of file Integrator.H.

◆ interval

int Integrator::Integrator::interval = -1

Definition at line 444 of file Integrator.H.

◆ istep

amrex::Vector<int> Integrator::Integrator::istep
protected

Keep track of where each level is.

Definition at line 359 of file Integrator.H.

◆ m_basefields

std::vector<BaseField*> Integrator::Integrator::m_basefields
protected

Definition at line 437 of file Integrator.H.

◆ m_basefields_cell

std::vector<BaseField*> Integrator::Integrator::m_basefields_cell
protected

Definition at line 438 of file Integrator.H.

◆ max

Set::Scalar Integrator::Integrator::max = NAN

Definition at line 273 of file Integrator.H.

◆ max_plot_level

int Integrator::Integrator::max_plot_level = -1
private

Definition at line 401 of file Integrator.H.

◆ max_step

int Integrator::Integrator::max_step = std::numeric_limits<int>::max()
private

Maximum allowable timestep.

Definition at line 404 of file Integrator.H.

◆ min

Set::Scalar Integrator::Integrator::min = NAN

Definition at line 272 of file Integrator.H.

◆ name_array

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

Definition at line 418 of file Integrator.H.

◆ names

std::vector<std::string> Integrator::Integrator::names

Definition at line 450 of file Integrator.H.

◆ ncomp_array

std::vector<int> Integrator::Integrator::ncomp_array

Definition at line 416 of file Integrator.H.

◆ nghost_array

std::vector<int> Integrator::Integrator::nghost_array

Definition at line 417 of file Integrator.H.

◆ node

struct { ... } Integrator::Integrator::node

◆ nprevious

int Integrator::Integrator::nprevious = -1

Definition at line 270 of file Integrator.H.

◆ nsubsteps

amrex::Vector<int> Integrator::Integrator::nsubsteps
protected

how many substeps on each level?

Definition at line 399 of file Integrator.H.

◆ number

int Integrator::Integrator::number = 0

Definition at line 448 of file Integrator.H.

◆ number_of_fabs

int Integrator::Integrator::number_of_fabs = 0

Definition at line 414 of file Integrator.H.

◆ on [1/2]

bool Integrator::Integrator::on = false

Definition at line 268 of file Integrator.H.

◆ on [2/2]

int Integrator::Integrator::on = 0

Definition at line 462 of file Integrator.H.

◆ physbc_array

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

Definition at line 419 of file Integrator.H.

◆ plot_dt

Set::Scalar Integrator::Integrator::plot_dt = NAN

Definition at line 447 of file Integrator.H.

◆ plot_file

std::string Integrator::Integrator::plot_file { "plt" }
protected

Plotfile name.

Definition at line 361 of file Integrator.H.

◆ plot_int

int Integrator::Integrator::plot_int = -1

How frequently to dump plot file (default: never)

Definition at line 446 of file Integrator.H.

◆ previous_timesteps

std::vector<Set::Scalar> Integrator::Integrator::previous_timesteps

Definition at line 276 of file Integrator.H.

◆ regrid_int

int Integrator::Integrator::regrid_int = -1
protected

Determine how often to regrid (default: 2)

Definition at line 455 of file Integrator.H.

◆ restart_file_cell

std::string Integrator::Integrator::restart_file_cell = ""
protected

Definition at line 458 of file Integrator.H.

◆ restart_file_node

std::string Integrator::Integrator::restart_file_node = ""
protected

Definition at line 459 of file Integrator.H.

◆ stop_time

amrex::Real Integrator::Integrator::stop_time = NAN
private

Default stop time.

Definition at line 406 of file Integrator.H.

◆ t_new

amrex::Vector<amrex::Real> Integrator::Integrator::t_new
protected

Keep track of current old simulation time on each level.

Definition at line 358 of file Integrator.H.

◆ t_old

amrex::Vector<amrex::Real> Integrator::Integrator::t_old
private

Keep track of current old simulation time on each level.

Definition at line 403 of file Integrator.H.

◆ thermo

struct { ... } Integrator::Integrator::thermo

◆ timestep

amrex::Real Integrator::Integrator::timestep = NAN
protected

Timestep for the base level of refinement.

Definition at line 397 of file Integrator.H.

◆ tstart

amrex::Real Integrator::Integrator::tstart = 0
private

Default start time (default: 0)

Definition at line 405 of file Integrator.H.

◆ vars

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

Definition at line 449 of file Integrator.H.

◆ verbose

int Integrator::Integrator::verbose = -1

Definition at line 269 of file Integrator.H.

◆ writeout_array

std::vector<bool> Integrator::Integrator::writeout_array

Definition at line 420 of file Integrator.H.

The documentation for this class was generated from the following files:
Integrator
Collection of numerical integrator objects.
Definition: AllenCahn.H:40
Generated on Sat Feb 8 2025 00:07:40 for Alamo by   doxygen 1.8.17