Flow123d  master-f44eb46
Public Member Functions | Public Attributes | List of all members
AddPotentialFactory< spacedim, Value > Class Template Reference

#include <field_add_potential.hh>

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

Public Member Functions

 AddPotentialFactory (Field< 3, FieldValue< 3 >::VectorFixed > &gravity, FieldCoords &coords, Field< 3, FieldValue< 3 >::Scalar > &inner_field)
 Constructor. More...
 
Field< spacedim, Value >::FieldBasePtr create_field (Input::Record rec, const FieldCommon &) override
 
bool is_active_field_descriptor (const Input::Record &in_rec, FMT_UNUSED const std::string &input_name) override
 
- Public Member Functions inherited from Field< spacedim, Value >::FactoryBase
virtual bool is_active_field_descriptor (const Input::Record &in_rec, const std::string &input_name)
 

Public Attributes

Field< 3, FieldValue< 3 >::VectorFixed > & gravity_
 
FieldCoordscoords_
 
Field< 3, FieldValue< 3 >::Scalar > & inner_field_
 
std::string field_name_
 

Detailed Description

template<int spacedim, class Value>
class AddPotentialFactory< spacedim, Value >

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

Definition at line 49 of file field_add_potential.hh.

Constructor & Destructor Documentation

◆ AddPotentialFactory()

template<int spacedim, class Value >
AddPotentialFactory< spacedim, Value >::AddPotentialFactory ( Field< 3, FieldValue< 3 >::VectorFixed > &  gravity,
FieldCoords coords,
Field< 3, FieldValue< 3 >::Scalar > &  inner_field 
)
inline

Constructor.

Definition at line 52 of file field_add_potential.hh.

Member Function Documentation

◆ create_field()

template<int spacedim, class Value >
Field<spacedim,Value>::FieldBasePtr AddPotentialFactory< spacedim, Value >::create_field ( Input::Record  rec,
const FieldCommon field 
)
inlineoverridevirtual

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 59 of file field_add_potential.hh.

◆ is_active_field_descriptor()

template<int spacedim, class Value >
bool AddPotentialFactory< spacedim, Value >::is_active_field_descriptor ( const Input::Record in_rec,
FMT_UNUSED const std::string &  input_name 
)
inlineoverride

Definition at line 69 of file field_add_potential.hh.

Member Data Documentation

◆ coords_

template<int spacedim, class Value >
FieldCoords& AddPotentialFactory< spacedim, Value >::coords_

Definition at line 74 of file field_add_potential.hh.

◆ field_name_

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

Definition at line 76 of file field_add_potential.hh.

◆ gravity_

template<int spacedim, class Value >
Field<3, FieldValue<3>::VectorFixed >& AddPotentialFactory< spacedim, Value >::gravity_

Definition at line 73 of file field_add_potential.hh.

◆ inner_field_

template<int spacedim, class Value >
Field<3, FieldValue<3>::Scalar>& AddPotentialFactory< spacedim, Value >::inner_field_

Definition at line 75 of file field_add_potential.hh.


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