oomph::FluidInterfaceAdditionalValues< ELEMENT > Class Template Reference

#include <specific_node_update_interface_elements.h>

Public Member Functions
	FluidInterfaceAdditionalValues ()
	Empty constructor. More...
unsigned	nadditional_values (const unsigned &n)
void	setup_equation_indices (ELEMENT *const &element_pt, const unsigned &id)

Private Member Functions
void	error_message ()

Detailed Description

template<class ELEMENT>
class oomph::FluidInterfaceAdditionalValues< ELEMENT >

This policy class is used to allow additional values to be added to the nodes from new surface equations, for examples of usage see the SurfactantTransportFluidInterfaceElements. The use of this class avoids issues with calling virtual functions in constructors and avoids having a global look-up able, although it functions in much the same way. Typically, this will only be filled in by "expert users" and is only required if you want to write generic surface-element classes. Specific classes can always be overloaded on a case-by-case basis.

Constructor & Destructor Documentation

FluidInterfaceAdditionalValues()

template<class ELEMENT >

oomph::FluidInterfaceAdditionalValues< ELEMENT >::FluidInterfaceAdditionalValues ( )

inline

Empty constructor.

{}

Member Function Documentation

error_message()

template<class ELEMENT >

void oomph::FluidInterfaceAdditionalValues< ELEMENT >::error_message ( )

inlineprivate

    {
      std::ostringstream error_message;
      error_message
        << "The generic FluidInterfaceAdditionalValues<ELEMENT> class has "
           "been\n"
        << "called. This should never happen. If you are creating your own\n"
        << "surface equations you must overload the policy class to specify\n"
        << "how many additional values are required at the surface nodes.\n"
        << "For an example, see "
           "src/fluid_interface/surfactant_transport_elements.h\n"
        << std::endl;
      throw OomphLibError(
        error_message.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
    }

References OOMPH_CURRENT_FUNCTION, and OOMPH_EXCEPTION_LOCATION.

Referenced by oomph::FluidInterfaceAdditionalValues< FluidInterfaceElement >::FluidInterfaceAdditionalValues(), and oomph::FluidInterfaceAdditionalValues< ELEMENT >::nadditional_values().

nadditional_values()

template<class ELEMENT >

unsigned oomph::FluidInterfaceAdditionalValues< ELEMENT >::nadditional_values ( const unsigned &  n )

inline

Specific interface that states how many additional values are required for the n-th node. Default is zero, but issue error_message.

    {
      error_message();
      return 0;
    }

References oomph::FluidInterfaceAdditionalValues< ELEMENT >::error_message().

Referenced by oomph::ElasticUpdateFluidInterfaceElement< EQUATION_CLASS, DERIVATIVE_CLASS, ELEMENT >::ElasticUpdateFluidInterfaceElement(), and oomph::SpineUpdateFluidInterfaceElement< EQUATION_CLASS, DERIVATIVE_CLASS, ELEMENT >::SpineUpdateFluidInterfaceElement().

setup_equation_indices()

template<class ELEMENT >

void oomph::FluidInterfaceAdditionalValues< ELEMENT >::setup_equation_indices ( ELEMENT *const &  element_pt, const unsigned &  id  )

inline

Specify any additional index setup information that is required; i.e. the look-up schemes for the additional values. Default is empty with error message

    {
      error_message();
    }

Referenced by oomph::ElasticUpdateFluidInterfaceElement< EQUATION_CLASS, DERIVATIVE_CLASS, ELEMENT >::ElasticUpdateFluidInterfaceElement(), and oomph::SpineUpdateFluidInterfaceElement< EQUATION_CLASS, DERIVATIVE_CLASS, ELEMENT >::SpineUpdateFluidInterfaceElement().

---

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

• specific_node_update_interface_elements.h