#include <field_python.hh>
Inheritance diagram for FieldPython< spacedim, Value >:
Collaboration diagram for FieldPython< spacedim, Value >:
Public Types | |
| typedef FieldAlgorithmBase< spacedim, Value >::Point | Point |
| typedef FieldAlgorithmBase< spacedim, Value > | FactoryBaseType |
 Public Types inherited from FieldAlgorithmBase< spacedim, Value > | |
| typedef Space< spacedim >::Point | Point |
Public Member Functions | |
| FieldPython (unsigned int n_comp=0) | |
| virtual void | init_from_input (const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data) |
| void | set_python_field_from_file (const FilePath &file_name, const string &func_name) |
| void | set_python_field_from_string (const string &python_source, const string &func_name) |
| virtual Value::return_type const & | value (const Point &p, const ElementAccessor< spacedim > &elm) |
| virtual void | value_list (const Armor::array &point_list, const ElementAccessor< spacedim > &elm, std::vector< typename Value::return_type > &value_list) |
| virtual | ~FieldPython () |
| Public Member Functions inherited from FieldAlgorithmBase< spacedim, Value > | |
| FieldAlgorithmBase (unsigned int n_comp=0) | |
| virtual bool | set_time (const TimeStep &time) |
| virtual void | set_mesh (const Mesh *mesh, bool boundary_domain) |
| void | set_component_idx (unsigned int idx) |
| unsigned int | n_comp () const |
| FieldResult | field_result () const |
| virtual double | next_change_time () |
| virtual void | cache_reinit (const ElementCacheMap &cache_map) |
| Allows reinit data members or structures in descendants during reinit of FieldValueCache of 'parental' Field<> More... | |
| virtual void | cache_update (FieldValueCache< typename Value::element_type > &data_cache, ElementCacheMap &cache_map, unsigned int region_patch_idx) |
| virtual void | set_native_dh (std::shared_ptr< DOFHandlerMultiDim >) |
| bool | is_constant_in_space () const |
| virtual std::vector< const FieldCommon * > | set_dependency (FMT_UNUSED FieldSet &field_set) |
| virtual | ~FieldAlgorithmBase () |
Static Public Member Functions | |
| static const Input::Type::Record & | get_input_type () |
| Implementation. More... | |
| Static Public Member Functions inherited from FieldAlgorithmBase< spacedim, Value > | |
| static std::string | template_name () |
| static Input::Type::Abstract & | get_input_type () |
| static const Input::Type::Instance & | get_input_type_instance (Input::Type::Selection value_selection=Input::Type::Selection()) |
| static const Input::Type::Record & | get_field_algo_common_keys () |
| static std::shared_ptr< FieldAlgorithmBase< spacedim, Value > > | function_factory (const Input::AbstractRecord &rec, const struct FieldAlgoBaseInitData &init_data) |
Private Member Functions | |
| void | set_func (const string &func_name) |
| void | set_value (const Point &p, const ElementAccessor< spacedim > &elm, Value &value) |
Static Private Attributes | |
| static const int | registrar |
| Registrar of class to factory. More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from FieldAlgorithmBase< spacedim, Value > | |
| static const unsigned int | spacedim_ =spacedim |
| static constexpr bool | is_enum_valued = std::is_same<typename Value::element_type, FieldEnum>::value |
| Protected Member Functions inherited from FieldAlgorithmBase< spacedim, Value > | |
| void | init_unit_conversion_coefficient (const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data) |
Init value of unit_conversion_coefficient_ from input. More... | |
| Protected Attributes inherited from FieldAlgorithmBase< spacedim, Value > | |
| TimeStep | time_ |
| Actual time level; initial value is -infinity. More... | |
| Value | value_ |
| Last value, prevents passing large values (vectors) by value. More... | |
| Value::return_type | r_value_ |
| FieldResult | field_result_ |
| Indicator of particular values (zero, one) constant over space. More... | |
| unsigned int | component_idx_ |
| Specify if the field is part of a MultiField and which component it is. More... | |
| double | unit_conversion_coefficient_ |
| Coeficient of conversion of user-defined unit. More... | |
| bool | is_constant_in_space_ |
| Flag detects that field is only dependent on time. More... | |
Detailed Description
template<int spacedim, class Value>
class FieldPython< spacedim, Value >
This class assumes field python field with spacedim arguments containing coordinates of the given point. The field should return a tuple representing a vector value (possibly of size one for scalar fields)
TODO:
- use rather only one argument - tuple representing the whole point
- time fields
- set some parameter in the python module
- for fields with one component allow python fields returning the value directly
Definition at line 46 of file field_python.hh.
Member Typedef Documentation
template<int spacedim, class Value >
| typedef FieldAlgorithmBase<spacedim, Value> FieldPython< spacedim, Value >::FactoryBaseType |
Definition at line 50 of file field_python.hh.
template<int spacedim, class Value >
| typedef FieldAlgorithmBase<spacedim, Value>::Point FieldPython< spacedim, Value >::Point |
Definition at line 49 of file field_python.hh.
Constructor & Destructor Documentation
template<int spacedim, class Value >
| FieldPython< spacedim, Value >::FieldPython | ( | unsigned int | n_comp = 0 | ) |
Definition at line 60 of file field_python.impl.hh.
template<int spacedim, class Value >
|
virtual |
Definition at line 212 of file field_python.impl.hh.
Member Function Documentation
template<int spacedim, class Value >
|
static |
Implementation.
Definition at line 34 of file field_python.impl.hh.
template<int spacedim, class Value >
|
virtual |
Function can provide way to initialize itself from the input data.
TODO: make protected, should be called through function factory
Reimplemented from FieldAlgorithmBase< spacedim, Value >.
Definition at line 91 of file field_python.impl.hh.
template<int spacedim, class Value >
|
private |
Common part of set_python_field_from_* methods
Definition at line 121 of file field_python.impl.hh.
Here is the caller graph for this function:
template<int spacedim, class Value >
| void FieldPython< spacedim, Value >::set_python_field_from_file | ( | const FilePath & | file_name, |
| const string & | func_name | ||
| ) |
Set the file and field to be called. TODO: use FilePath
Definition at line 109 of file field_python.impl.hh.
Here is the caller graph for this function:
template<int spacedim, class Value >
| void FieldPython< spacedim, Value >::set_python_field_from_string | ( | const string & | python_source, |
| const string & | func_name | ||
| ) |
Set the source in a string and name of the field to be called.
Definition at line 78 of file field_python.impl.hh.
Here is the caller graph for this function:
template<int spacedim, class Value >
|
inlineprivate |
Implementation.
Returns one vector value in one given point.
Definition at line 189 of file field_python.impl.hh.
Here is the caller graph for this function:
template<int spacedim, class Value >
|
virtual |
Returns one value in one given point. ResultType can be used to avoid some costly calculation if the result is trivial.
Implements FieldAlgorithmBase< spacedim, Value >.
Definition at line 158 of file field_python.impl.hh.
Here is the caller graph for this function:
template<int spacedim, class Value >
|
virtual |
Returns std::vector of scalar values in several points at once.
Implements FieldAlgorithmBase< spacedim, Value >.
Definition at line 170 of file field_python.impl.hh.
Member Data Documentation
template<int spacedim, class Value >
|
staticprivate |
Initial value:
=
Input::register_class< FieldPython<spacedim, Value>, unsigned int >("FieldPython") +
Registrar of class to factory.
Definition at line 85 of file field_python.hh.
The documentation for this class was generated from the following files:
- /opt/flow123d/flow123d/src/fields/field_python.hh
- /opt/flow123d/flow123d/src/fields/field_python.impl.hh
