ablate::boundarySolver::physics::subModels::SublimationModel Class Reference

Inheritance diagram for ablate::boundarySolver::physics::subModels::SublimationModel:

Classes
struct	SurfaceState

Public Member Functions
virtual bool	RequiresUpdate ()
virtual void	Initialize (ablate::boundarySolver::BoundarySolver &bSolver)
virtual PetscErrorCode	Update (PetscInt faceId, PetscReal dt, PetscReal heatFluxToSurface, PetscReal &temperature)
virtual PetscErrorCode	Compute (PetscInt faceId, PetscReal heatFluxToSurface, SurfaceState &)=0
	~SublimationModel () override=default
SerializerType	Serialize () const override
const std::string &	GetId () const override
PetscErrorCode	Save (PetscViewer viewer, PetscInt sequenceNumber, PetscReal time) override
PetscErrorCode	Restore (PetscViewer viewer, PetscInt sequenceNumber, PetscReal time) override

Additional Inherited Members
Public Types inherited from ablate::io::Serializable
enum class	SerializerType { none , collective , serial }
Static Protected Member Functions inherited from ablate::io::Serializable
static PetscErrorCode	SaveKeyValue (PetscViewer viewer, const char *name, PetscScalar value)
static PetscErrorCode	RestoreKeyValue (PetscViewer viewer, const char *name, PetscScalar &value)
template<class T >
static PetscErrorCode	SaveKeyValue (PetscViewer viewer, const char *name, T value)
template<class T >
static PetscErrorCode	RestoreKeyValue (PetscViewer viewer, const char *name, T &value)
template<class T >
static SerializerType	DetermineSerializerType (const T &types)

Constructor & Destructor Documentation

~SublimationModel()

ablate::boundarySolver::physics::subModels::SublimationModel::~SublimationModel ( )

overridedefault

Allow model cleanup

Member Function Documentation

Compute()

virtual PetscErrorCode ablate::boundarySolver::physics::subModels::SublimationModel::Compute ( PetscInt  faceId, PetscReal  heatFluxToSurface, SurfaceState &    )

pure virtual

Returns the current surface state for a face and current heatflux

Parameters

heatFluxToSurface

Implemented in ablate::boundarySolver::physics::subModels::TemperatureSublimation, ablate::boundarySolver::physics::subModels::CompleteSublimation, and ablate::boundarySolver::physics::subModels::ArrheniusSublimation.

GetId()

const std::string& ablate::boundarySolver::physics::subModels::SublimationModel::GetId ( ) const

inlineoverridevirtual

only required function, returns the id of the object. Should be unique for the simulation

Returns

Implements ablate::io::Serializable.

Initialize()

virtual void ablate::boundarySolver::physics::subModels::SublimationModel::Initialize ( ablate::boundarySolver::BoundarySolver &  bSolver )

inlinevirtual

Initialize the subModel for each face id in the bSolver

Parameters

bSolver

Returns

bool indicating if this model needs to be updated before each prestep

Reimplemented in ablate::boundarySolver::physics::subModels::TemperatureSublimation, and ablate::boundarySolver::physics::subModels::ArrheniusSublimation.

RequiresUpdate()

virtual bool ablate::boundarySolver::physics::subModels::SublimationModel::RequiresUpdate ( )

inlinevirtual

bool indicating if this model needs to be updated before each prestep

Parameters

bSolver

Returns

Reimplemented in ablate::boundarySolver::physics::subModels::TemperatureSublimation, and ablate::boundarySolver::physics::subModels::ArrheniusSublimation.

Restore()

PetscErrorCode ablate::boundarySolver::physics::subModels::SublimationModel::Restore ( PetscViewer  viewer, PetscInt  sequenceNumber, PetscReal  time  )

inlineoverridevirtual

Restore the state from the PetscViewer

Parameters

viewer
sequenceNumber
time

Implements ablate::io::Serializable.

Reimplemented in ablate::boundarySolver::physics::subModels::TemperatureSublimation.

Save()

PetscErrorCode ablate::boundarySolver::physics::subModels::SublimationModel::Save ( PetscViewer  viewer, PetscInt  sequenceNumber, PetscReal  time  )

inlineoverridevirtual

Save the state to the PetscViewer

Parameters

viewer
sequenceNumber
time

Implements ablate::io::Serializable.

Reimplemented in ablate::boundarySolver::physics::subModels::TemperatureSublimation.

Serialize()

SerializerType ablate::boundarySolver::physics::subModels::SublimationModel::Serialize ( ) const

inlineoverridevirtual

assume that the sublimation model does not need to Serialize

Returns

Reimplemented from ablate::io::Serializable.

Reimplemented in ablate::boundarySolver::physics::subModels::TemperatureSublimation.

Update()

virtual PetscErrorCode ablate::boundarySolver::physics::subModels::SublimationModel::Update ( PetscInt  faceId, PetscReal  dt, PetscReal  heatFluxToSurface, PetscReal &  temperature  )

inlinevirtual

Initialize the subModel for each face id in the bSolver

Parameters

bSolver

Returns

bool indicating if this model needs to be updated before each prestep

Reimplemented in ablate::boundarySolver::physics::subModels::TemperatureSublimation, and ablate::boundarySolver::physics::subModels::ArrheniusSublimation.

---

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

• src/boundarySolver/physics/subModels/sublimationModel.hpp