Flow123d  release_2.2.0-914-gf1a3a4f
Public Member Functions | Public Attributes | List of all members
FieldAddPotential< spacedim, Value >::FieldFactory Class Reference

#include <field_add_potential.hh>

Inheritance diagram for FieldAddPotential< spacedim, Value >::FieldFactory:
Inheritance graph
[legend]
Collaboration diagram for FieldAddPotential< spacedim, Value >::FieldFactory:
Collaboration graph
[legend]

Public Member Functions

 FieldFactory (arma::vec::fixed< spacedim+1 > potential, std::string field_name)
 Constructor. More...
 
virtual Field< spacedim, Value >::FieldBasePtr create_field (Input::Record rec, const FieldCommon &field)
 
bool is_active_field_descriptor (const Input::Record &in_rec, const std::string &input_name) override
 

Public Attributes

arma::vec::fixed< spacedim+1 > potential_
 
std::string field_name_
 

Detailed Description

template<int spacedim, class Value>
class FieldAddPotential< spacedim, Value >::FieldFactory

Factory class (descendant of Field<...>::FactoryBase) that is necessary for setting pressure values are piezometric head values.

Definition at line 52 of file field_add_potential.hh.

Constructor & Destructor Documentation

template<int spacedim, class Value >
FieldAddPotential< spacedim, Value >::FieldFactory::FieldFactory ( arma::vec::fixed< spacedim+1 >  potential,
std::string  field_name 
)
inline

Constructor.

Definition at line 55 of file field_add_potential.hh.

Member Function Documentation

template<int spacedim, class Value >
virtual Field<spacedim,Value>::FieldBasePtr FieldAddPotential< spacedim, Value >::FieldFactory::create_field ( Input::Record  rec,
const FieldCommon field 
)
inlinevirtual

Default method that creates an instance of FieldBase for field.

Reads key given by field_name and creates the field instance using FieldBase<...>::function_factory.

Reimplemented from Field< spacedim, Value >::FactoryBase.

Definition at line 60 of file field_add_potential.hh.

template<int spacedim, class Value >
bool FieldAddPotential< spacedim, Value >::FieldFactory::is_active_field_descriptor ( const Input::Record in_rec,
const std::string &  input_name 
)
inlineoverridevirtual

Check if Input::Record accessor contains data of field given by input_name.

Returns true when ever the method create_field returns non-null pointer, otherwise returns false.

Reimplemented from Field< spacedim, Value >::FactoryBase.

Definition at line 69 of file field_add_potential.hh.

Member Data Documentation

template<int spacedim, class Value >
std::string FieldAddPotential< spacedim, Value >::FieldFactory::field_name_

Definition at line 74 of file field_add_potential.hh.

template<int spacedim, class Value >
arma::vec::fixed<spacedim+1> FieldAddPotential< spacedim, Value >::FieldFactory::potential_

Definition at line 73 of file field_add_potential.hh.


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