Functions
void	addClassDescription (InputParameters &params, const std::string &desc)
	Add the supplied class description if thermochimica is available, otherwise add a warning message. More...

void	checkLibraryAvailability (MooseObject &self)
	Check if thermochimica is available and throw an error if it is not. More...

void	checkLibraryAvailability (Action &self)

Variables
static const std::string	message

Function Documentation

◆ addClassDescription()

void ThermochimicaUtils::addClassDescription	(	InputParameters &	params,
		const std::string &	desc
	)

Add the supplied class description if thermochimica is available, otherwise add a warning message.

Definition at line 23 of file ThermochimicaUtils.C.

Referenced by ChemicalCompositionAction::validParams(), and ThermochimicaDataBase< is_nodal >::validParams().

 {
 #ifdef THERMOCHIMICA_ENABLED
   params.addClassDescription(desc);
 #else
   params.addClassDescription(message + " (Original description: " + desc + ")");
 #endif
 }

◆ checkLibraryAvailability() [1/2]

void ThermochimicaUtils::checkLibraryAvailability ( MooseObject & self )

Check if thermochimica is available and throw an error if it is not.

Definition at line 33 of file ThermochimicaUtils.C.

Referenced by ChemicalCompositionAction::ChemicalCompositionAction(), and ThermochimicaDataBase< is_nodal >::ThermochimicaDataBase().

 {
 #ifndef THERMOCHIMICA_ENABLED
   self.paramError("type", message);
 #else
   libmesh_ignore(self);
 #endif
 }

◆ checkLibraryAvailability() [2/2]

void ThermochimicaUtils::checkLibraryAvailability ( Action & self )

Definition at line 43 of file ThermochimicaUtils.C.

 {
 #ifndef THERMOCHIMICA_ENABLED
   mooseError(self.parameters().blockLocation() + ": " + message);
 #else
   libmesh_ignore(self);
 #endif
 }

Variable Documentation

◆ message

const std::string ThermochimicaUtils::message

static

Initial value:

=
    "To use this object, you need to have the `Thermochimica` library installed. Refer to the "
    "documentation for guidance on how to enable it."

Definition at line 18 of file ThermochimicaUtils.C.

Referenced by addClassDescription(), checkLibraryAvailability(), MultiParameterPlasticityStressUpdate::errorHandler(), TraceRay::failTrace(), stdb_abqerr_(), and SinglePhaseFluidProperties::unimplementedDerivativeMethod().