Flow123d  release_2.2.0-914-gf1a3a4f
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Attributes | List of all members
FieldPython< spacedim, Value > Class Template Reference

#include <field_python.hh>

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

Public Types

typedef FieldAlgorithmBase< spacedim, Value >::Point Point
 
typedef FieldAlgorithmBase< spacedim, ValueFactoryBaseType
 
- 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 std::vector< Point > &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 ~FieldAlgorithmBase ()
 

Static Public Member Functions

static const Input::Type::Recordget_input_type ()
 Implementation. More...
 
- Static Public Member Functions inherited from FieldAlgorithmBase< spacedim, Value >
static std::string template_name ()
 
static Input::Type::Abstractget_input_type ()
 
static const Input::Type::Instanceget_input_type_instance (Input::Type::Selection value_selection=Input::Type::Selection())
 
static const Input::Type::Recordget_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 = boost::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...
 

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:

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 >
FieldPython< spacedim, Value >::~FieldPython ( )
virtual

Definition at line 209 of file field_python.impl.hh.

Member Function Documentation

template<int spacedim, class Value >
const Input::Type::Record & FieldPython< spacedim, Value >::get_input_type ( )
static

Implementation.

Definition at line 34 of file field_python.impl.hh.

template<int spacedim, class Value >
void FieldPython< spacedim, Value >::init_from_input ( const Input::Record rec,
const struct FieldAlgoBaseInitData init_data 
)
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 89 of file field_python.impl.hh.

template<int spacedim, class Value >
void FieldPython< spacedim, Value >::set_func ( const string &  func_name)
private

Common part of set_python_field_from_* methods

Definition at line 119 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 107 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 76 of file field_python.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
void FieldPython< spacedim, Value >::set_value ( const Point p,
const ElementAccessor< spacedim > &  elm,
Value value 
)
inlineprivate

Implementation.

Returns one vector value in one given point.

Definition at line 186 of file field_python.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
Value::return_type const & FieldPython< spacedim, Value >::value ( const Point p,
const ElementAccessor< spacedim > &  elm 
)
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 156 of file field_python.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
void FieldPython< spacedim, Value >::value_list ( const std::vector< Point > &  point_list,
const ElementAccessor< spacedim > &  elm,
std::vector< typename Value::return_type > &  value_list 
)
virtual

Returns std::vector of scalar values in several points at once.

Implements FieldAlgorithmBase< spacedim, Value >.

Definition at line 168 of file field_python.impl.hh.

Member Data Documentation

template<int spacedim, class Value >
const int FieldPython< spacedim, Value >::registrar
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: