Object

class Object : public godzilla::LoggingInterface

The base class for objects that can be created by Factory.

See also

Factory

Subclassed by godzilla::AuxiliaryField, godzilla::BoundaryCondition, godzilla::Function, godzilla::InitialCondition, godzilla::MeshObject, godzilla::Output, godzilla::Postprocessor, godzilla::Problem, godzilla::RZSymmetry, godzilla::TimeSteppingAdaptor

Public Functions

explicit Object(const Parameters &parameters)

Constructor for building the object via Factory.

const std::string &get_type() const

Get the type of this object.

Returns:

the name of the type of this object

const std::string &get_name() const

Get the name of the object.

Returns:

The name of the object

const Parameters &get_parameters() const

Get the parameters of the object.

Returns:

The parameters of the object

template<typename T>
const T &get_param(const std::string &par_name) const

Retrieve a parameter for the object.

Parameters:

par_name – The name of the parameter

Returns:

The value of the parameter

bool is_param_valid(const std::string &par_name) const

Test if the supplied parameter is valid.

Parameters:

par_name – The name of the parameter to test

App *get_app() const

Get the App this object is associated with.

const mpi::Communicator &get_comm() const

Get the MPI comm this object works on.

int get_processor_id() const

Get processor ID (aka MPI rank) this object is running at.

virtual void create()

Called to construct the object.

Public Static Functions

static Parameters parameters()

Method for building Parameters for this class.